blob: 22b89e4d6d19db7df724b1775d6aa386bc1c9818 [file] [log] [blame]
wdenk717b5aa2002-04-27 11:09:31 +00001/*
2 * NS16550 Serial Port
Stefan Roesea47a12b2010-04-15 16:07:28 +02003 * originally from linux source (arch/powerpc/boot/ns16550.h)
Detlev Zundel200779e2009-04-03 11:53:01 +02004 *
5 * Cleanup and unification
6 * (C) 2009 by Detlev Zundel, DENX Software Engineering GmbH
7 *
wdenk717b5aa2002-04-27 11:09:31 +00008 * modified slightly to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02009 * have addresses as offsets from CONFIG_SYS_ISA_BASE
wdenk717b5aa2002-04-27 11:09:31 +000010 * added a few more definitions
11 * added prototypes for ns16550.c
12 * reduced no of com ports to 2
13 * modifications (c) Rob Taylor, Flying Pig Systems. 2000.
Wolfgang Denkb87dfd22006-07-19 13:50:38 +020014 *
Heiko Schocherf5e0d032006-06-19 11:02:41 +020015 * added support for port on 64-bit bus
16 * by Richard Danter (richard.danter@windriver.com), (C) 2005 Wind River Systems
wdenk717b5aa2002-04-27 11:09:31 +000017 */
18
Detlev Zundel453c0d72009-04-03 16:45:46 +020019/*
20 * Note that the following macro magic uses the fact that the compiler
21 * will not allocate storage for arrays of size 0
22 */
23
Dave Aldridge79df1202011-09-01 22:47:14 +000024#include <linux/types.h>
25
Simon Glass12e431b2014-09-04 16:27:34 -060026#ifdef CONFIG_DM_SERIAL
27/*
28 * For driver model we always use one byte per register, and sort out the
29 * differences in the driver
30 */
31#define CONFIG_SYS_NS16550_REG_SIZE (-1)
32#endif
33
Detlev Zundel453c0d72009-04-03 16:45:46 +020034#if !defined(CONFIG_SYS_NS16550_REG_SIZE) || (CONFIG_SYS_NS16550_REG_SIZE == 0)
wdenk717b5aa2002-04-27 11:09:31 +000035#error "Please define NS16550 registers size."
Simon Glass90914002015-05-12 14:55:02 -060036#elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_DM_SERIAL)
Dave Aldridge79df1202011-09-01 22:47:14 +000037#define UART_REG(x) u32 x
Detlev Zundel453c0d72009-04-03 16:45:46 +020038#elif (CONFIG_SYS_NS16550_REG_SIZE > 0)
39#define UART_REG(x) \
40 unsigned char prepad_##x[CONFIG_SYS_NS16550_REG_SIZE - 1]; \
41 unsigned char x;
42#elif (CONFIG_SYS_NS16550_REG_SIZE < 0)
43#define UART_REG(x) \
44 unsigned char x; \
45 unsigned char postpad_##x[-CONFIG_SYS_NS16550_REG_SIZE - 1];
wdenk717b5aa2002-04-27 11:09:31 +000046#endif
47
Simon Glass12e431b2014-09-04 16:27:34 -060048/**
49 * struct ns16550_platdata - information about a NS16550 port
50 *
51 * @base: Base register address
Andy Shevchenko4e720772018-11-20 23:52:35 +020052 * @reg_width: IO accesses size of registers (in bytes)
Simon Glass12e431b2014-09-04 16:27:34 -060053 * @reg_shift: Shift size of registers (0=byte, 1=16bit, 2=32bit...)
54 * @clock: UART base clock speed in Hz
55 */
56struct ns16550_platdata {
Simon Glass167efe02014-10-22 21:37:04 -060057 unsigned long base;
Andy Shevchenko4e720772018-11-20 23:52:35 +020058 int reg_width;
Simon Glass12e431b2014-09-04 16:27:34 -060059 int reg_shift;
Michal Simek59b35dd2016-02-16 16:17:49 +010060 int reg_offset;
Andy Shevchenko0af76162018-11-20 23:52:34 +020061 int clock;
Marek Vasut65f83802016-12-01 02:06:29 +010062 u32 fcr;
Simon Glass12e431b2014-09-04 16:27:34 -060063};
64
65struct udevice;
66
Detlev Zundel453c0d72009-04-03 16:45:46 +020067struct NS16550 {
68 UART_REG(rbr); /* 0 */
69 UART_REG(ier); /* 1 */
70 UART_REG(fcr); /* 2 */
71 UART_REG(lcr); /* 3 */
72 UART_REG(mcr); /* 4 */
73 UART_REG(lsr); /* 5 */
74 UART_REG(msr); /* 6 */
75 UART_REG(spr); /* 7 */
Mikhail Kshevetskiy99b603e2012-07-09 08:52:43 +000076#ifdef CONFIG_SOC_DA8XX
77 UART_REG(reg8); /* 8 */
78 UART_REG(reg9); /* 9 */
79 UART_REG(revid1); /* A */
80 UART_REG(revid2); /* B */
81 UART_REG(pwr_mgmt); /* C */
82 UART_REG(mdr1); /* D */
83#else
Detlev Zundel453c0d72009-04-03 16:45:46 +020084 UART_REG(mdr1); /* 8 */
85 UART_REG(reg9); /* 9 */
86 UART_REG(regA); /* A */
87 UART_REG(regB); /* B */
88 UART_REG(regC); /* C */
89 UART_REG(regD); /* D */
90 UART_REG(regE); /* E */
91 UART_REG(uasr); /* F */
92 UART_REG(scr); /* 10*/
93 UART_REG(ssr); /* 11*/
Mikhail Kshevetskiy99b603e2012-07-09 08:52:43 +000094#endif
Simon Glass12e431b2014-09-04 16:27:34 -060095#ifdef CONFIG_DM_SERIAL
96 struct ns16550_platdata *plat;
97#endif
Detlev Zundel453c0d72009-04-03 16:45:46 +020098};
99
wdenk717b5aa2002-04-27 11:09:31 +0000100#define thr rbr
101#define iir fcr
102#define dll rbr
103#define dlm ier
104
Simon Glassf8df9d02011-10-15 19:14:09 +0000105typedef struct NS16550 *NS16550_t;
wdenk717b5aa2002-04-27 11:09:31 +0000106
Detlev Zundel200779e2009-04-03 11:53:01 +0200107/*
108 * These are the definitions for the FIFO Control Register
109 */
Simon Glassf8df9d02011-10-15 19:14:09 +0000110#define UART_FCR_FIFO_EN 0x01 /* Fifo enable */
Detlev Zundel200779e2009-04-03 11:53:01 +0200111#define UART_FCR_CLEAR_RCVR 0x02 /* Clear the RCVR FIFO */
112#define UART_FCR_CLEAR_XMIT 0x04 /* Clear the XMIT FIFO */
113#define UART_FCR_DMA_SELECT 0x08 /* For DMA applications */
114#define UART_FCR_TRIGGER_MASK 0xC0 /* Mask for the FIFO trigger range */
115#define UART_FCR_TRIGGER_1 0x00 /* Mask for trigger set at 1 */
116#define UART_FCR_TRIGGER_4 0x40 /* Mask for trigger set at 4 */
117#define UART_FCR_TRIGGER_8 0x80 /* Mask for trigger set at 8 */
118#define UART_FCR_TRIGGER_14 0xC0 /* Mask for trigger set at 14 */
wdenk717b5aa2002-04-27 11:09:31 +0000119
Detlev Zundel200779e2009-04-03 11:53:01 +0200120#define UART_FCR_RXSR 0x02 /* Receiver soft reset */
121#define UART_FCR_TXSR 0x04 /* Transmitter soft reset */
wdenk717b5aa2002-04-27 11:09:31 +0000122
Marek Vasut0b060ee2016-12-01 02:06:31 +0100123/* Ingenic JZ47xx specific UART-enable bit. */
124#define UART_FCR_UME 0x10
125
Heiko Schocher17fa0322017-01-18 08:05:49 +0100126/* Clear & enable FIFOs */
127#define UART_FCR_DEFVAL (UART_FCR_FIFO_EN | \
128 UART_FCR_RXSR | \
129 UART_FCR_TXSR)
130
Detlev Zundel200779e2009-04-03 11:53:01 +0200131/*
132 * These are the definitions for the Modem Control Register
133 */
134#define UART_MCR_DTR 0x01 /* DTR */
135#define UART_MCR_RTS 0x02 /* RTS */
136#define UART_MCR_OUT1 0x04 /* Out 1 */
137#define UART_MCR_OUT2 0x08 /* Out 2 */
138#define UART_MCR_LOOP 0x10 /* Enable loopback test mode */
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400139#define UART_MCR_AFE 0x20 /* Enable auto-RTS/CTS */
wdenk717b5aa2002-04-27 11:09:31 +0000140
Detlev Zundel200779e2009-04-03 11:53:01 +0200141#define UART_MCR_DMA_EN 0x04
142#define UART_MCR_TX_DFR 0x08
wdenk717b5aa2002-04-27 11:09:31 +0000143
Detlev Zundel200779e2009-04-03 11:53:01 +0200144/*
145 * These are the definitions for the Line Control Register
146 *
147 * Note: if the word length is 5 bits (UART_LCR_WLEN5), then setting
148 * UART_LCR_STOP will select 1.5 stop bits, not 2 stop bits.
149 */
150#define UART_LCR_WLS_MSK 0x03 /* character length select mask */
151#define UART_LCR_WLS_5 0x00 /* 5 bit character length */
152#define UART_LCR_WLS_6 0x01 /* 6 bit character length */
153#define UART_LCR_WLS_7 0x02 /* 7 bit character length */
154#define UART_LCR_WLS_8 0x03 /* 8 bit character length */
Simon Glassf8df9d02011-10-15 19:14:09 +0000155#define UART_LCR_STB 0x04 /* # stop Bits, off=1, on=1.5 or 2) */
Detlev Zundel200779e2009-04-03 11:53:01 +0200156#define UART_LCR_PEN 0x08 /* Parity eneble */
157#define UART_LCR_EPS 0x10 /* Even Parity Select */
158#define UART_LCR_STKP 0x20 /* Stick Parity */
159#define UART_LCR_SBRK 0x40 /* Set Break */
160#define UART_LCR_BKSE 0x80 /* Bank select enable */
161#define UART_LCR_DLAB 0x80 /* Divisor latch access bit */
162
163/*
164 * These are the definitions for the Line Status Register
165 */
166#define UART_LSR_DR 0x01 /* Data ready */
167#define UART_LSR_OE 0x02 /* Overrun */
168#define UART_LSR_PE 0x04 /* Parity error */
169#define UART_LSR_FE 0x08 /* Framing error */
170#define UART_LSR_BI 0x10 /* Break */
171#define UART_LSR_THRE 0x20 /* Xmit holding register empty */
172#define UART_LSR_TEMT 0x40 /* Xmitter empty */
173#define UART_LSR_ERR 0x80 /* Error */
174
175#define UART_MSR_DCD 0x80 /* Data Carrier Detect */
176#define UART_MSR_RI 0x40 /* Ring Indicator */
177#define UART_MSR_DSR 0x20 /* Data Set Ready */
178#define UART_MSR_CTS 0x10 /* Clear to Send */
179#define UART_MSR_DDCD 0x08 /* Delta DCD */
180#define UART_MSR_TERI 0x04 /* Trailing edge ring indicator */
181#define UART_MSR_DDSR 0x02 /* Delta DSR */
182#define UART_MSR_DCTS 0x01 /* Delta CTS */
183
184/*
185 * These are the definitions for the Interrupt Identification Register
186 */
187#define UART_IIR_NO_INT 0x01 /* No interrupts pending */
188#define UART_IIR_ID 0x06 /* Mask for the interrupt ID */
189
190#define UART_IIR_MSI 0x00 /* Modem status interrupt */
191#define UART_IIR_THRI 0x02 /* Transmitter holding register empty */
192#define UART_IIR_RDI 0x04 /* Receiver data interrupt */
193#define UART_IIR_RLSI 0x06 /* Receiver line status interrupt */
194
195/*
196 * These are the definitions for the Interrupt Enable Register
197 */
198#define UART_IER_MSI 0x08 /* Enable Modem status interrupt */
199#define UART_IER_RLSI 0x04 /* Enable receiver line status interrupt */
200#define UART_IER_THRI 0x02 /* Enable Transmitter holding register int. */
201#define UART_IER_RDI 0x01 /* Enable receiver data interrupt */
202
wdenk717b5aa2002-04-27 11:09:31 +0000203/* useful defaults for LCR */
Detlev Zundel200779e2009-04-03 11:53:01 +0200204#define UART_LCR_8N1 0x03
wdenk717b5aa2002-04-27 11:09:31 +0000205
Simon Glassf8df9d02011-10-15 19:14:09 +0000206void NS16550_init(NS16550_t com_port, int baud_divisor);
207void NS16550_putc(NS16550_t com_port, char c);
208char NS16550_getc(NS16550_t com_port);
209int NS16550_tstc(NS16550_t com_port);
210void NS16550_reinit(NS16550_t com_port, int baud_divisor);
Simon Glassfa54eb12014-09-04 16:27:32 -0600211
212/**
213 * ns16550_calc_divisor() - calculate the divisor given clock and baud rate
214 *
215 * Given the UART input clock and required baudrate, calculate the divisor
216 * that should be used.
217 *
218 * @port: UART port
219 * @clock: UART input clock speed in Hz
220 * @baudrate: Required baud rate
221 * @return baud rate divisor that should be used
222 */
223int ns16550_calc_divisor(NS16550_t port, int clock, int baudrate);
Simon Glass12e431b2014-09-04 16:27:34 -0600224
225/**
226 * ns16550_serial_ofdata_to_platdata() - convert DT to platform data
227 *
228 * Decode a device tree node for an ns16550 device. This includes the
229 * register base address and register shift properties. The caller must set
230 * up the clock frequency.
231 *
232 * @dev: dev to decode platform data for
233 * @return: 0 if OK, -EINVAL on error
234 */
235int ns16550_serial_ofdata_to_platdata(struct udevice *dev);
236
237/**
238 * ns16550_serial_probe() - probe a serial port
239 *
240 * This sets up the serial port ready for use, except for the baud rate
241 * @return 0, or -ve on error
242 */
243int ns16550_serial_probe(struct udevice *dev);
244
245/**
246 * struct ns16550_serial_ops - ns16550 serial operations
247 *
248 * These should be used by the client driver for the driver's 'ops' member
249 */
250extern const struct dm_serial_ops ns16550_serial_ops;