1// SPDX-License-Identifier: GPL-2.0-only
2/* Copyright (c) 2020, Broadcom */
3/*
4 * 8250-core based driver for Broadcom ns16550a UARTs
5 *
6 * This driver uses the standard 8250 driver core but adds additional
7 * optional features including the ability to use a baud rate clock
8 * mux for more accurate high speed baud rate selection and also
9 * an optional DMA engine.
10 *
11 */
12
13#include <linux/module.h>
14#include <linux/types.h>
15#include <linux/tty.h>
16#include <linux/errno.h>
17#include <linux/device.h>
18#include <linux/io.h>
19#include <linux/of.h>
20#include <linux/dma-mapping.h>
21#include <linux/tty_flip.h>
22#include <linux/delay.h>
23#include <linux/clk.h>
24#include <linux/debugfs.h>
25
26#include "8250.h"
27
28/* Register definitions for UART DMA block. Version 1.1 or later. */
29#define UDMA_ARB_RX		0x00
30#define UDMA_ARB_TX		0x04
31#define		UDMA_ARB_REQ				0x00000001
32#define		UDMA_ARB_GRANT				0x00000002
33
34#define UDMA_RX_REVISION	0x00
35#define UDMA_RX_REVISION_REQUIRED			0x00000101
36#define UDMA_RX_CTRL		0x04
37#define		UDMA_RX_CTRL_BUF_CLOSE_MODE		0x00010000
38#define		UDMA_RX_CTRL_MASK_WR_DONE		0x00008000
39#define		UDMA_RX_CTRL_ENDIAN_OVERRIDE		0x00004000
40#define		UDMA_RX_CTRL_ENDIAN			0x00002000
41#define		UDMA_RX_CTRL_OE_IS_ERR			0x00001000
42#define		UDMA_RX_CTRL_PE_IS_ERR			0x00000800
43#define		UDMA_RX_CTRL_FE_IS_ERR			0x00000400
44#define		UDMA_RX_CTRL_NUM_BUF_USED_MASK		0x000003c0
45#define		UDMA_RX_CTRL_NUM_BUF_USED_SHIFT	6
46#define		UDMA_RX_CTRL_BUF_CLOSE_CLK_SEL_SYS	0x00000020
47#define		UDMA_RX_CTRL_BUF_CLOSE_ENA		0x00000010
48#define		UDMA_RX_CTRL_TIMEOUT_CLK_SEL_SYS	0x00000008
49#define		UDMA_RX_CTRL_TIMEOUT_ENA		0x00000004
50#define		UDMA_RX_CTRL_ABORT			0x00000002
51#define		UDMA_RX_CTRL_ENA			0x00000001
52#define UDMA_RX_STATUS		0x08
53#define		UDMA_RX_STATUS_ACTIVE_BUF_MASK		0x0000000f
54#define UDMA_RX_TRANSFER_LEN	0x0c
55#define UDMA_RX_TRANSFER_TOTAL	0x10
56#define UDMA_RX_BUFFER_SIZE	0x14
57#define UDMA_RX_SRC_ADDR	0x18
58#define UDMA_RX_TIMEOUT		0x1c
59#define UDMA_RX_BUFFER_CLOSE	0x20
60#define UDMA_RX_BLOCKOUT_COUNTER 0x24
61#define UDMA_RX_BUF0_PTR_LO	0x28
62#define UDMA_RX_BUF0_PTR_HI	0x2c
63#define UDMA_RX_BUF0_STATUS	0x30
64#define		UDMA_RX_BUFX_STATUS_OVERRUN_ERR		0x00000010
65#define		UDMA_RX_BUFX_STATUS_FRAME_ERR		0x00000008
66#define		UDMA_RX_BUFX_STATUS_PARITY_ERR		0x00000004
67#define		UDMA_RX_BUFX_STATUS_CLOSE_EXPIRED	0x00000002
68#define		UDMA_RX_BUFX_STATUS_DATA_RDY		0x00000001
69#define UDMA_RX_BUF0_DATA_LEN	0x34
70#define UDMA_RX_BUF1_PTR_LO	0x38
71#define UDMA_RX_BUF1_PTR_HI	0x3c
72#define UDMA_RX_BUF1_STATUS	0x40
73#define UDMA_RX_BUF1_DATA_LEN	0x44
74
75#define UDMA_TX_REVISION	0x00
76#define UDMA_TX_REVISION_REQUIRED			0x00000101
77#define UDMA_TX_CTRL		0x04
78#define		UDMA_TX_CTRL_ENDIAN_OVERRIDE		0x00000080
79#define		UDMA_TX_CTRL_ENDIAN			0x00000040
80#define		UDMA_TX_CTRL_NUM_BUF_USED_MASK		0x00000030
81#define		UDMA_TX_CTRL_NUM_BUF_USED_1		0x00000010
82#define		UDMA_TX_CTRL_ABORT			0x00000002
83#define		UDMA_TX_CTRL_ENA			0x00000001
84#define UDMA_TX_DST_ADDR	0x08
85#define UDMA_TX_BLOCKOUT_COUNTER 0x10
86#define UDMA_TX_TRANSFER_LEN	0x14
87#define UDMA_TX_TRANSFER_TOTAL	0x18
88#define UDMA_TX_STATUS		0x20
89#define UDMA_TX_BUF0_PTR_LO	0x24
90#define UDMA_TX_BUF0_PTR_HI	0x28
91#define UDMA_TX_BUF0_STATUS	0x2c
92#define		UDMA_TX_BUFX_LAST			0x00000002
93#define		UDMA_TX_BUFX_EMPTY			0x00000001
94#define UDMA_TX_BUF0_DATA_LEN	0x30
95#define UDMA_TX_BUF0_DATA_SENT	0x34
96#define UDMA_TX_BUF1_PTR_LO	0x38
97
98#define UDMA_INTR_STATUS	0x00
99#define		UDMA_INTR_ARB_TX_GRANT			0x00040000
100#define		UDMA_INTR_ARB_RX_GRANT			0x00020000
101#define		UDMA_INTR_TX_ALL_EMPTY			0x00010000
102#define		UDMA_INTR_TX_EMPTY_BUF1			0x00008000
103#define		UDMA_INTR_TX_EMPTY_BUF0			0x00004000
104#define		UDMA_INTR_TX_ABORT			0x00002000
105#define		UDMA_INTR_TX_DONE			0x00001000
106#define		UDMA_INTR_RX_ERROR			0x00000800
107#define		UDMA_INTR_RX_TIMEOUT			0x00000400
108#define		UDMA_INTR_RX_READY_BUF7			0x00000200
109#define		UDMA_INTR_RX_READY_BUF6			0x00000100
110#define		UDMA_INTR_RX_READY_BUF5			0x00000080
111#define		UDMA_INTR_RX_READY_BUF4			0x00000040
112#define		UDMA_INTR_RX_READY_BUF3			0x00000020
113#define		UDMA_INTR_RX_READY_BUF2			0x00000010
114#define		UDMA_INTR_RX_READY_BUF1			0x00000008
115#define		UDMA_INTR_RX_READY_BUF0			0x00000004
116#define		UDMA_INTR_RX_READY_MASK			0x000003fc
117#define		UDMA_INTR_RX_READY_SHIFT		2
118#define		UDMA_INTR_RX_ABORT			0x00000002
119#define		UDMA_INTR_RX_DONE			0x00000001
120#define UDMA_INTR_SET		0x04
121#define UDMA_INTR_CLEAR		0x08
122#define UDMA_INTR_MASK_STATUS	0x0c
123#define UDMA_INTR_MASK_SET	0x10
124#define UDMA_INTR_MASK_CLEAR	0x14
125
126
127#define UDMA_RX_INTERRUPTS ( \
128	UDMA_INTR_RX_ERROR | \
129	UDMA_INTR_RX_TIMEOUT | \
130	UDMA_INTR_RX_READY_BUF0 | \
131	UDMA_INTR_RX_READY_BUF1 | \
132	UDMA_INTR_RX_READY_BUF2 | \
133	UDMA_INTR_RX_READY_BUF3 | \
134	UDMA_INTR_RX_READY_BUF4 | \
135	UDMA_INTR_RX_READY_BUF5 | \
136	UDMA_INTR_RX_READY_BUF6 | \
137	UDMA_INTR_RX_READY_BUF7 | \
138	UDMA_INTR_RX_ABORT | \
139	UDMA_INTR_RX_DONE)
140
141#define UDMA_RX_ERR_INTERRUPTS ( \
142	UDMA_INTR_RX_ERROR | \
143	UDMA_INTR_RX_TIMEOUT | \
144	UDMA_INTR_RX_ABORT | \
145	UDMA_INTR_RX_DONE)
146
147#define UDMA_TX_INTERRUPTS ( \
148	UDMA_INTR_TX_ABORT | \
149	UDMA_INTR_TX_DONE)
150
151#define UDMA_IS_RX_INTERRUPT(status) ((status) & UDMA_RX_INTERRUPTS)
152#define UDMA_IS_TX_INTERRUPT(status) ((status) & UDMA_TX_INTERRUPTS)
153
154
155/* Current devices have 8 sets of RX buffer registers */
156#define UDMA_RX_BUFS_COUNT	8
157#define UDMA_RX_BUFS_REG_OFFSET (UDMA_RX_BUF1_PTR_LO - UDMA_RX_BUF0_PTR_LO)
158#define UDMA_RX_BUFx_PTR_LO(x)	(UDMA_RX_BUF0_PTR_LO + \
159				 ((x) * UDMA_RX_BUFS_REG_OFFSET))
160#define UDMA_RX_BUFx_PTR_HI(x)	(UDMA_RX_BUF0_PTR_HI + \
161				 ((x) * UDMA_RX_BUFS_REG_OFFSET))
162#define UDMA_RX_BUFx_STATUS(x)	(UDMA_RX_BUF0_STATUS + \
163				 ((x) * UDMA_RX_BUFS_REG_OFFSET))
164#define UDMA_RX_BUFx_DATA_LEN(x) (UDMA_RX_BUF0_DATA_LEN + \
165				  ((x) * UDMA_RX_BUFS_REG_OFFSET))
166
167/* Current devices have 2 sets of TX buffer registers */
168#define UDMA_TX_BUFS_COUNT	2
169#define UDMA_TX_BUFS_REG_OFFSET (UDMA_TX_BUF1_PTR_LO - UDMA_TX_BUF0_PTR_LO)
170#define UDMA_TX_BUFx_PTR_LO(x)	(UDMA_TX_BUF0_PTR_LO + \
171				 ((x) * UDMA_TX_BUFS_REG_OFFSET))
172#define UDMA_TX_BUFx_PTR_HI(x)	(UDMA_TX_BUF0_PTR_HI + \
173				 ((x) * UDMA_TX_BUFS_REG_OFFSET))
174#define UDMA_TX_BUFx_STATUS(x)	(UDMA_TX_BUF0_STATUS + \
175				 ((x) * UDMA_TX_BUFS_REG_OFFSET))
176#define UDMA_TX_BUFx_DATA_LEN(x) (UDMA_TX_BUF0_DATA_LEN + \
177				  ((x) * UDMA_TX_BUFS_REG_OFFSET))
178#define UDMA_TX_BUFx_DATA_SENT(x) (UDMA_TX_BUF0_DATA_SENT + \
179				   ((x) * UDMA_TX_BUFS_REG_OFFSET))
180#define REGS_8250 0
181#define REGS_DMA_RX 1
182#define REGS_DMA_TX 2
183#define REGS_DMA_ISR 3
184#define REGS_DMA_ARB 4
185#define REGS_MAX 5
186
187#define TX_BUF_SIZE 4096
188#define RX_BUF_SIZE 4096
189#define RX_BUFS_COUNT 2
190#define KHZ    1000
191#define MHZ(x) ((x) * KHZ * KHZ)
192
193static const u32 brcmstb_rate_table[] = {
194	MHZ(81),
195	MHZ(108),
196	MHZ(64),		/* Actually 64285715 for some chips */
197	MHZ(48),
198};
199
200static const u32 brcmstb_rate_table_7278[] = {
201	MHZ(81),
202	MHZ(108),
203	0,
204	MHZ(48),
205};
206
207struct brcmuart_priv {
208	int		line;
209	struct clk	*baud_mux_clk;
210	unsigned long	default_mux_rate;
211	u32		real_rates[ARRAY_SIZE(brcmstb_rate_table)];
212	const u32	*rate_table;
213	ktime_t		char_wait;
214	struct uart_port *up;
215	struct hrtimer	hrt;
216	bool		shutdown;
217	bool		dma_enabled;
218	struct uart_8250_dma dma;
219	void __iomem	*regs[REGS_MAX];
220	dma_addr_t	rx_addr;
221	void		*rx_bufs;
222	size_t		rx_size;
223	int		rx_next_buf;
224	dma_addr_t	tx_addr;
225	void		*tx_buf;
226	size_t		tx_size;
227	bool		tx_running;
228	bool		rx_running;
229	struct dentry	*debugfs_dir;
230
231	/* stats exposed through debugfs */
232	u64		dma_rx_partial_buf;
233	u64		dma_rx_full_buf;
234	u32		rx_bad_timeout_late_char;
235	u32		rx_bad_timeout_no_char;
236	u32		rx_missing_close_timeout;
237	u32		rx_err;
238	u32		rx_timeout;
239	u32		rx_abort;
240	u32		saved_mctrl;
241};
242
243static struct dentry *brcmuart_debugfs_root;
244
245/*
246 * Register access routines
247 */
248static u32 udma_readl(struct brcmuart_priv *priv,
249		int reg_type, int offset)
250{
251	return readl(priv->regs[reg_type] + offset);
252}
253
254static void udma_writel(struct brcmuart_priv *priv,
255			int reg_type, int offset, u32 value)
256{
257	writel(value, priv->regs[reg_type] + offset);
258}
259
260static void udma_set(struct brcmuart_priv *priv,
261		int reg_type, int offset, u32 bits)
262{
263	void __iomem *reg = priv->regs[reg_type] + offset;
264	u32 value;
265
266	value = readl(reg);
267	value |= bits;
268	writel(value, reg);
269}
270
271static void udma_unset(struct brcmuart_priv *priv,
272		int reg_type, int offset, u32 bits)
273{
274	void __iomem *reg = priv->regs[reg_type] + offset;
275	u32 value;
276
277	value = readl(reg);
278	value &= ~bits;
279	writel(value, reg);
280}
281
282/*
283 * The UART DMA engine hardware can be used by multiple UARTS, but
284 * only one at a time. Sharing is not currently supported so
285 * the first UART to request the DMA engine will get it and any
286 * subsequent requests by other UARTS will fail.
287 */
288static int brcmuart_arbitration(struct brcmuart_priv *priv, bool acquire)
289{
290	u32 rx_grant;
291	u32 tx_grant;
292	int waits;
293	int ret = 0;
294
295	if (acquire) {
296		udma_set(priv, REGS_DMA_ARB, UDMA_ARB_RX, UDMA_ARB_REQ);
297		udma_set(priv, REGS_DMA_ARB, UDMA_ARB_TX, UDMA_ARB_REQ);
298
299		waits = 1;
300		while (1) {
301			rx_grant = udma_readl(priv, REGS_DMA_ARB, UDMA_ARB_RX);
302			tx_grant = udma_readl(priv, REGS_DMA_ARB, UDMA_ARB_TX);
303			if (rx_grant & tx_grant & UDMA_ARB_GRANT)
304				return 0;
305			if (waits-- == 0)
306				break;
307			msleep(1);
308		}
309		ret = 1;
310	}
311
312	udma_unset(priv, REGS_DMA_ARB, UDMA_ARB_RX, UDMA_ARB_REQ);
313	udma_unset(priv, REGS_DMA_ARB, UDMA_ARB_TX, UDMA_ARB_REQ);
314	return ret;
315}
316
317static void brcmuart_init_dma_hardware(struct brcmuart_priv *priv)
318{
319	u32 daddr;
320	u32 value;
321	int x;
322
323	/* Start with all interrupts disabled */
324	udma_writel(priv, REGS_DMA_ISR, UDMA_INTR_MASK_SET, 0xffffffff);
325
326	udma_writel(priv, REGS_DMA_RX, UDMA_RX_BUFFER_SIZE, RX_BUF_SIZE);
327
328	/*
329	 * Setup buffer close to happen when 32 character times have
330	 * elapsed since the last character was received.
331	 */
332	udma_writel(priv, REGS_DMA_RX, UDMA_RX_BUFFER_CLOSE, 16*10*32);
333	value = (RX_BUFS_COUNT << UDMA_RX_CTRL_NUM_BUF_USED_SHIFT)
334		| UDMA_RX_CTRL_BUF_CLOSE_MODE
335		| UDMA_RX_CTRL_BUF_CLOSE_ENA;
336	udma_writel(priv, REGS_DMA_RX, UDMA_RX_CTRL, value);
337
338	udma_writel(priv, REGS_DMA_RX, UDMA_RX_BLOCKOUT_COUNTER, 0);
339	daddr = priv->rx_addr;
340	for (x = 0; x < RX_BUFS_COUNT; x++) {
341
342		/* Set RX transfer length to 0 for unknown */
343		udma_writel(priv, REGS_DMA_RX, UDMA_RX_TRANSFER_LEN, 0);
344
345		udma_writel(priv, REGS_DMA_RX, UDMA_RX_BUFx_PTR_LO(x),
346			    lower_32_bits(daddr));
347		udma_writel(priv, REGS_DMA_RX, UDMA_RX_BUFx_PTR_HI(x),
348			    upper_32_bits(daddr));
349		daddr += RX_BUF_SIZE;
350	}
351
352	daddr = priv->tx_addr;
353	udma_writel(priv, REGS_DMA_TX, UDMA_TX_BUFx_PTR_LO(0),
354		    lower_32_bits(daddr));
355	udma_writel(priv, REGS_DMA_TX, UDMA_TX_BUFx_PTR_HI(0),
356		    upper_32_bits(daddr));
357	udma_writel(priv, REGS_DMA_TX, UDMA_TX_CTRL,
358		    UDMA_TX_CTRL_NUM_BUF_USED_1);
359
360	/* clear all interrupts then enable them */
361	udma_writel(priv, REGS_DMA_ISR, UDMA_INTR_CLEAR, 0xffffffff);
362	udma_writel(priv, REGS_DMA_ISR, UDMA_INTR_MASK_CLEAR,
363		UDMA_RX_INTERRUPTS | UDMA_TX_INTERRUPTS);
364
365}
366
367static void start_rx_dma(struct uart_8250_port *p)
368{
369	struct brcmuart_priv *priv = p->port.private_data;
370	int x;
371
372	udma_unset(priv, REGS_DMA_RX, UDMA_RX_CTRL, UDMA_RX_CTRL_ENA);
373
374	/* Clear the RX ready bit for all buffers */
375	for (x = 0; x < RX_BUFS_COUNT; x++)
376		udma_unset(priv, REGS_DMA_RX, UDMA_RX_BUFx_STATUS(x),
377			UDMA_RX_BUFX_STATUS_DATA_RDY);
378
379	/* always start with buffer 0 */
380	udma_unset(priv, REGS_DMA_RX, UDMA_RX_STATUS,
381		   UDMA_RX_STATUS_ACTIVE_BUF_MASK);
382	priv->rx_next_buf = 0;
383
384	udma_set(priv, REGS_DMA_RX, UDMA_RX_CTRL, UDMA_RX_CTRL_ENA);
385	priv->rx_running = true;
386}
387
388static void stop_rx_dma(struct uart_8250_port *p)
389{
390	struct brcmuart_priv *priv = p->port.private_data;
391
392	/* If RX is running, set the RX ABORT */
393	if (priv->rx_running)
394		udma_set(priv, REGS_DMA_RX, UDMA_RX_CTRL, UDMA_RX_CTRL_ABORT);
395}
396
397static int stop_tx_dma(struct uart_8250_port *p)
398{
399	struct brcmuart_priv *priv = p->port.private_data;
400	u32 value;
401
402	/* If TX is running, set the TX ABORT */
403	value = udma_readl(priv, REGS_DMA_TX, UDMA_TX_CTRL);
404	if (value & UDMA_TX_CTRL_ENA)
405		udma_set(priv, REGS_DMA_TX, UDMA_TX_CTRL, UDMA_TX_CTRL_ABORT);
406	priv->tx_running = false;
407	return 0;
408}
409
410/*
411 * NOTE: printk's in this routine will hang the system if this is
412 * the console tty
413 */
414static int brcmuart_tx_dma(struct uart_8250_port *p)
415{
416	struct brcmuart_priv *priv = p->port.private_data;
417	struct circ_buf *xmit = &p->port.state->xmit;
418	u32 tx_size;
419
420	if (uart_tx_stopped(&p->port) || priv->tx_running ||
421		uart_circ_empty(xmit)) {
422		return 0;
423	}
424	tx_size = CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE);
425
426	priv->dma.tx_err = 0;
427	memcpy(priv->tx_buf, &xmit->buf[xmit->tail], tx_size);
428	uart_xmit_advance(&p->port, tx_size);
429
430	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
431		uart_write_wakeup(&p->port);
432
433	udma_writel(priv, REGS_DMA_TX, UDMA_TX_TRANSFER_LEN, tx_size);
434	udma_writel(priv, REGS_DMA_TX, UDMA_TX_BUF0_DATA_LEN, tx_size);
435	udma_unset(priv, REGS_DMA_TX, UDMA_TX_BUF0_STATUS, UDMA_TX_BUFX_EMPTY);
436	udma_set(priv, REGS_DMA_TX, UDMA_TX_CTRL, UDMA_TX_CTRL_ENA);
437	priv->tx_running = true;
438
439	return 0;
440}
441
442static void brcmuart_rx_buf_done_isr(struct uart_port *up, int index)
443{
444	struct brcmuart_priv *priv = up->private_data;
445	struct tty_port *tty_port = &up->state->port;
446	u32 status;
447	u32 length;
448	u32 copied;
449
450	/* Make sure we're still in sync with the hardware */
451	status = udma_readl(priv, REGS_DMA_RX, UDMA_RX_BUFx_STATUS(index));
452	length = udma_readl(priv, REGS_DMA_RX, UDMA_RX_BUFx_DATA_LEN(index));
453
454	if ((status & UDMA_RX_BUFX_STATUS_DATA_RDY) == 0) {
455		dev_err(up->dev, "RX done interrupt but DATA_RDY not found\n");
456		return;
457	}
458	if (status & (UDMA_RX_BUFX_STATUS_OVERRUN_ERR |
459		      UDMA_RX_BUFX_STATUS_FRAME_ERR |
460		      UDMA_RX_BUFX_STATUS_PARITY_ERR)) {
461		if (status & UDMA_RX_BUFX_STATUS_OVERRUN_ERR) {
462			up->icount.overrun++;
463			dev_warn(up->dev, "RX OVERRUN Error\n");
464		}
465		if (status & UDMA_RX_BUFX_STATUS_FRAME_ERR) {
466			up->icount.frame++;
467			dev_warn(up->dev, "RX FRAMING Error\n");
468		}
469		if (status & UDMA_RX_BUFX_STATUS_PARITY_ERR) {
470			up->icount.parity++;
471			dev_warn(up->dev, "RX PARITY Error\n");
472		}
473	}
474	copied = (u32)tty_insert_flip_string(
475		tty_port,
476		priv->rx_bufs + (index * RX_BUF_SIZE),
477		length);
478	if (copied != length) {
479		dev_warn(up->dev, "Flip buffer overrun of %d bytes\n",
480			 length - copied);
481		up->icount.overrun += length - copied;
482	}
483	up->icount.rx += length;
484	if (status & UDMA_RX_BUFX_STATUS_CLOSE_EXPIRED)
485		priv->dma_rx_partial_buf++;
486	else if (length != RX_BUF_SIZE)
487		/*
488		 * This is a bug in the controller that doesn't cause
489		 * any problems but will be fixed in the future.
490		 */
491		priv->rx_missing_close_timeout++;
492	else
493		priv->dma_rx_full_buf++;
494
495	tty_flip_buffer_push(tty_port);
496}
497
498static void brcmuart_rx_isr(struct uart_port *up, u32 rx_isr)
499{
500	struct brcmuart_priv *priv = up->private_data;
501	struct device *dev = up->dev;
502	u32 rx_done_isr;
503	u32 check_isr;
504
505	rx_done_isr = (rx_isr & UDMA_INTR_RX_READY_MASK);
506	while (rx_done_isr) {
507		check_isr = UDMA_INTR_RX_READY_BUF0 << priv->rx_next_buf;
508		if (check_isr & rx_done_isr) {
509			brcmuart_rx_buf_done_isr(up, priv->rx_next_buf);
510		} else {
511			dev_err(dev,
512				"RX buffer ready out of sequence, restarting RX DMA\n");
513			start_rx_dma(up_to_u8250p(up));
514			break;
515		}
516		if (rx_isr & UDMA_RX_ERR_INTERRUPTS) {
517			if (rx_isr & UDMA_INTR_RX_ERROR)
518				priv->rx_err++;
519			if (rx_isr & UDMA_INTR_RX_TIMEOUT) {
520				priv->rx_timeout++;
521				dev_err(dev, "RX TIMEOUT Error\n");
522			}
523			if (rx_isr & UDMA_INTR_RX_ABORT)
524				priv->rx_abort++;
525			priv->rx_running = false;
526		}
527		/* If not ABORT, re-enable RX buffer */
528		if (!(rx_isr & UDMA_INTR_RX_ABORT))
529			udma_unset(priv, REGS_DMA_RX,
530				   UDMA_RX_BUFx_STATUS(priv->rx_next_buf),
531				   UDMA_RX_BUFX_STATUS_DATA_RDY);
532		rx_done_isr &= ~check_isr;
533		priv->rx_next_buf++;
534		if (priv->rx_next_buf == RX_BUFS_COUNT)
535			priv->rx_next_buf = 0;
536	}
537}
538
539static void brcmuart_tx_isr(struct uart_port *up, u32 isr)
540{
541	struct brcmuart_priv *priv = up->private_data;
542	struct device *dev = up->dev;
543	struct uart_8250_port *port_8250 = up_to_u8250p(up);
544	struct circ_buf	*xmit = &port_8250->port.state->xmit;
545
546	if (isr & UDMA_INTR_TX_ABORT) {
547		if (priv->tx_running)
548			dev_err(dev, "Unexpected TX_ABORT interrupt\n");
549		return;
550	}
551	priv->tx_running = false;
552	if (!uart_circ_empty(xmit) && !uart_tx_stopped(up))
553		brcmuart_tx_dma(port_8250);
554}
555
556static irqreturn_t brcmuart_isr(int irq, void *dev_id)
557{
558	struct uart_port *up = dev_id;
559	struct device *dev = up->dev;
560	struct brcmuart_priv *priv = up->private_data;
561	unsigned long flags;
562	u32 interrupts;
563	u32 rval;
564	u32 tval;
565
566	interrupts = udma_readl(priv, REGS_DMA_ISR, UDMA_INTR_STATUS);
567	if (interrupts == 0)
568		return IRQ_NONE;
569
570	spin_lock_irqsave(&up->lock, flags);
571
572	/* Clear all interrupts */
573	udma_writel(priv, REGS_DMA_ISR, UDMA_INTR_CLEAR, interrupts);
574
575	rval = UDMA_IS_RX_INTERRUPT(interrupts);
576	if (rval)
577		brcmuart_rx_isr(up, rval);
578	tval = UDMA_IS_TX_INTERRUPT(interrupts);
579	if (tval)
580		brcmuart_tx_isr(up, tval);
581	if ((rval | tval) == 0)
582		dev_warn(dev, "Spurious interrupt: 0x%x\n", interrupts);
583
584	spin_unlock_irqrestore(&up->lock, flags);
585	return IRQ_HANDLED;
586}
587
588static int brcmuart_startup(struct uart_port *port)
589{
590	int res;
591	struct uart_8250_port *up = up_to_u8250p(port);
592	struct brcmuart_priv *priv = up->port.private_data;
593
594	priv->shutdown = false;
595
596	/*
597	 * prevent serial8250_do_startup() from allocating non-existent
598	 * DMA resources
599	 */
600	up->dma = NULL;
601
602	res = serial8250_do_startup(port);
603	if (!priv->dma_enabled)
604		return res;
605	/*
606	 * Disable the Receive Data Interrupt because the DMA engine
607	 * will handle this.
608	 *
609	 * Synchronize UART_IER access against the console.
610	 */
611	spin_lock_irq(&port->lock);
612	up->ier &= ~UART_IER_RDI;
613	serial_port_out(port, UART_IER, up->ier);
614	spin_unlock_irq(&port->lock);
615
616	priv->tx_running = false;
617	priv->dma.rx_dma = NULL;
618	priv->dma.tx_dma = brcmuart_tx_dma;
619	up->dma = &priv->dma;
620
621	brcmuart_init_dma_hardware(priv);
622	start_rx_dma(up);
623	return res;
624}
625
626static void brcmuart_shutdown(struct uart_port *port)
627{
628	struct uart_8250_port *up = up_to_u8250p(port);
629	struct brcmuart_priv *priv = up->port.private_data;
630	unsigned long flags;
631
632	spin_lock_irqsave(&port->lock, flags);
633	priv->shutdown = true;
634	if (priv->dma_enabled) {
635		stop_rx_dma(up);
636		stop_tx_dma(up);
637		/* disable all interrupts */
638		udma_writel(priv, REGS_DMA_ISR, UDMA_INTR_MASK_SET,
639			UDMA_RX_INTERRUPTS | UDMA_TX_INTERRUPTS);
640	}
641
642	/*
643	 * prevent serial8250_do_shutdown() from trying to free
644	 * DMA resources that we never alloc'd for this driver.
645	 */
646	up->dma = NULL;
647
648	spin_unlock_irqrestore(&port->lock, flags);
649	serial8250_do_shutdown(port);
650}
651
652/*
653 * Not all clocks run at the exact specified rate, so set each requested
654 * rate and then get the actual rate.
655 */
656static void init_real_clk_rates(struct device *dev, struct brcmuart_priv *priv)
657{
658	int x;
659	int rc;
660
661	priv->default_mux_rate = clk_get_rate(priv->baud_mux_clk);
662	for (x = 0; x < ARRAY_SIZE(priv->real_rates); x++) {
663		if (priv->rate_table[x] == 0) {
664			priv->real_rates[x] = 0;
665			continue;
666		}
667		rc = clk_set_rate(priv->baud_mux_clk, priv->rate_table[x]);
668		if (rc) {
669			dev_err(dev, "Error selecting BAUD MUX clock for %u\n",
670				priv->rate_table[x]);
671			priv->real_rates[x] = priv->rate_table[x];
672		} else {
673			priv->real_rates[x] = clk_get_rate(priv->baud_mux_clk);
674		}
675	}
676	clk_set_rate(priv->baud_mux_clk, priv->default_mux_rate);
677}
678
679static void set_clock_mux(struct uart_port *up, struct brcmuart_priv *priv,
680			u32 baud)
681{
682	u32 percent;
683	u32 best_percent = UINT_MAX;
684	u32 quot;
685	u32 best_quot = 1;
686	u32 rate;
687	int best_index = -1;
688	u64 hires_rate;
689	u64 hires_baud;
690	u64 hires_err;
691	int rc;
692	int i;
693	int real_baud;
694
695	/* If the Baud Mux Clock was not specified, just return */
696	if (priv->baud_mux_clk == NULL)
697		return;
698
699	/* Find the closest match for specified baud */
700	for (i = 0; i < ARRAY_SIZE(priv->real_rates); i++) {
701		if (priv->real_rates[i] == 0)
702			continue;
703		rate = priv->real_rates[i] / 16;
704		quot = DIV_ROUND_CLOSEST(rate, baud);
705		if (!quot)
706			continue;
707
708		/* increase resolution to get xx.xx percent */
709		hires_rate = (u64)rate * 10000;
710		hires_baud = (u64)baud * 10000;
711
712		hires_err = div_u64(hires_rate, (u64)quot);
713
714		/* get the delta */
715		if (hires_err > hires_baud)
716			hires_err = (hires_err - hires_baud);
717		else
718			hires_err = (hires_baud - hires_err);
719
720		percent = (unsigned long)DIV_ROUND_CLOSEST_ULL(hires_err, baud);
721		dev_dbg(up->dev,
722			"Baud rate: %u, MUX Clk: %u, Error: %u.%u%%\n",
723			baud, priv->real_rates[i], percent / 100,
724			percent % 100);
725		if (percent < best_percent) {
726			best_percent = percent;
727			best_index = i;
728			best_quot = quot;
729		}
730	}
731	if (best_index == -1) {
732		dev_err(up->dev, "Error, %d BAUD rate is too fast.\n", baud);
733		return;
734	}
735	rate = priv->real_rates[best_index];
736	rc = clk_set_rate(priv->baud_mux_clk, rate);
737	if (rc)
738		dev_err(up->dev, "Error selecting BAUD MUX clock\n");
739
740	/* Error over 3 percent will cause data errors */
741	if (best_percent > 300)
742		dev_err(up->dev, "Error, baud: %d has %u.%u%% error\n",
743			baud, percent / 100, percent % 100);
744
745	real_baud = rate / 16 / best_quot;
746	dev_dbg(up->dev, "Selecting BAUD MUX rate: %u\n", rate);
747	dev_dbg(up->dev, "Requested baud: %u, Actual baud: %u\n",
748		baud, real_baud);
749
750	/* calc nanoseconds for 1.5 characters time at the given baud rate */
751	i = NSEC_PER_SEC / real_baud / 10;
752	i += (i / 2);
753	priv->char_wait = ns_to_ktime(i);
754
755	up->uartclk = rate;
756}
757
758static void brcmstb_set_termios(struct uart_port *up,
759				struct ktermios *termios,
760				const struct ktermios *old)
761{
762	struct uart_8250_port *p8250 = up_to_u8250p(up);
763	struct brcmuart_priv *priv = up->private_data;
764
765	if (priv->dma_enabled)
766		stop_rx_dma(p8250);
767	set_clock_mux(up, priv, tty_termios_baud_rate(termios));
768	serial8250_do_set_termios(up, termios, old);
769	if (p8250->mcr & UART_MCR_AFE)
770		p8250->port.status |= UPSTAT_AUTOCTS;
771	if (priv->dma_enabled)
772		start_rx_dma(p8250);
773}
774
775static int brcmuart_handle_irq(struct uart_port *p)
776{
777	unsigned int iir = serial_port_in(p, UART_IIR);
778	struct brcmuart_priv *priv = p->private_data;
779	struct uart_8250_port *up = up_to_u8250p(p);
780	unsigned int status;
781	unsigned long flags;
782	unsigned int ier;
783	unsigned int mcr;
784	int handled = 0;
785
786	/*
787	 * There's a bug in some 8250 cores where we get a timeout
788	 * interrupt but there is no data ready.
789	 */
790	if (((iir & UART_IIR_ID) == UART_IIR_RX_TIMEOUT) && !(priv->shutdown)) {
791		spin_lock_irqsave(&p->lock, flags);
792		status = serial_port_in(p, UART_LSR);
793		if ((status & UART_LSR_DR) == 0) {
794
795			ier = serial_port_in(p, UART_IER);
796			/*
797			 * if Receive Data Interrupt is enabled and
798			 * we're uing hardware flow control, deassert
799			 * RTS and wait for any chars in the pipline to
800			 * arrive and then check for DR again.
801			 */
802			if ((ier & UART_IER_RDI) && (up->mcr & UART_MCR_AFE)) {
803				ier &= ~(UART_IER_RLSI | UART_IER_RDI);
804				serial_port_out(p, UART_IER, ier);
805				mcr = serial_port_in(p, UART_MCR);
806				mcr &= ~UART_MCR_RTS;
807				serial_port_out(p, UART_MCR, mcr);
808				hrtimer_start(&priv->hrt, priv->char_wait,
809					      HRTIMER_MODE_REL);
810			} else {
811				serial_port_in(p, UART_RX);
812			}
813
814			handled = 1;
815		}
816		spin_unlock_irqrestore(&p->lock, flags);
817		if (handled)
818			return 1;
819	}
820	return serial8250_handle_irq(p, iir);
821}
822
823static enum hrtimer_restart brcmuart_hrtimer_func(struct hrtimer *t)
824{
825	struct brcmuart_priv *priv = container_of(t, struct brcmuart_priv, hrt);
826	struct uart_port *p = priv->up;
827	struct uart_8250_port *up = up_to_u8250p(p);
828	unsigned int status;
829	unsigned long flags;
830
831	if (priv->shutdown)
832		return HRTIMER_NORESTART;
833
834	spin_lock_irqsave(&p->lock, flags);
835	status = serial_port_in(p, UART_LSR);
836
837	/*
838	 * If a character did not arrive after the timeout, clear the false
839	 * receive timeout.
840	 */
841	if ((status & UART_LSR_DR) == 0) {
842		serial_port_in(p, UART_RX);
843		priv->rx_bad_timeout_no_char++;
844	} else {
845		priv->rx_bad_timeout_late_char++;
846	}
847
848	/* re-enable receive unless upper layer has disabled it */
849	if ((up->ier & (UART_IER_RLSI | UART_IER_RDI)) ==
850	    (UART_IER_RLSI | UART_IER_RDI)) {
851		status = serial_port_in(p, UART_IER);
852		status |= (UART_IER_RLSI | UART_IER_RDI);
853		serial_port_out(p, UART_IER, status);
854		status = serial_port_in(p, UART_MCR);
855		status |= UART_MCR_RTS;
856		serial_port_out(p, UART_MCR, status);
857	}
858	spin_unlock_irqrestore(&p->lock, flags);
859	return HRTIMER_NORESTART;
860}
861
862static const struct of_device_id brcmuart_dt_ids[] = {
863	{
864		.compatible = "brcm,bcm7278-uart",
865		.data = brcmstb_rate_table_7278,
866	},
867	{
868		.compatible = "brcm,bcm7271-uart",
869		.data = brcmstb_rate_table,
870	},
871	{},
872};
873
874MODULE_DEVICE_TABLE(of, brcmuart_dt_ids);
875
876static void brcmuart_free_bufs(struct device *dev, struct brcmuart_priv *priv)
877{
878	if (priv->rx_bufs)
879		dma_free_coherent(dev, priv->rx_size, priv->rx_bufs,
880				  priv->rx_addr);
881	if (priv->tx_buf)
882		dma_free_coherent(dev, priv->tx_size, priv->tx_buf,
883				  priv->tx_addr);
884}
885
886static void brcmuart_throttle(struct uart_port *port)
887{
888	struct brcmuart_priv *priv = port->private_data;
889
890	udma_writel(priv, REGS_DMA_ISR, UDMA_INTR_MASK_SET, UDMA_RX_INTERRUPTS);
891}
892
893static void brcmuart_unthrottle(struct uart_port *port)
894{
895	struct brcmuart_priv *priv = port->private_data;
896
897	udma_writel(priv, REGS_DMA_ISR, UDMA_INTR_MASK_CLEAR,
898		    UDMA_RX_INTERRUPTS);
899}
900
901static int debugfs_stats_show(struct seq_file *s, void *unused)
902{
903	struct brcmuart_priv *priv = s->private;
904
905	seq_printf(s, "rx_err:\t\t\t\t%u\n",
906		   priv->rx_err);
907	seq_printf(s, "rx_timeout:\t\t\t%u\n",
908		   priv->rx_timeout);
909	seq_printf(s, "rx_abort:\t\t\t%u\n",
910		   priv->rx_abort);
911	seq_printf(s, "rx_bad_timeout_late_char:\t%u\n",
912		   priv->rx_bad_timeout_late_char);
913	seq_printf(s, "rx_bad_timeout_no_char:\t\t%u\n",
914		   priv->rx_bad_timeout_no_char);
915	seq_printf(s, "rx_missing_close_timeout:\t%u\n",
916		   priv->rx_missing_close_timeout);
917	if (priv->dma_enabled) {
918		seq_printf(s, "dma_rx_partial_buf:\t\t%llu\n",
919			   priv->dma_rx_partial_buf);
920		seq_printf(s, "dma_rx_full_buf:\t\t%llu\n",
921			   priv->dma_rx_full_buf);
922	}
923	return 0;
924}
925DEFINE_SHOW_ATTRIBUTE(debugfs_stats);
926
927static void brcmuart_init_debugfs(struct brcmuart_priv *priv,
928				  const char *device)
929{
930	priv->debugfs_dir = debugfs_create_dir(device, brcmuart_debugfs_root);
931	debugfs_create_file("stats", 0444, priv->debugfs_dir, priv,
932			    &debugfs_stats_fops);
933}
934
935
936static int brcmuart_probe(struct platform_device *pdev)
937{
938	struct resource *regs;
939	struct device_node *np = pdev->dev.of_node;
940	const struct of_device_id *of_id = NULL;
941	struct uart_8250_port *new_port;
942	struct device *dev = &pdev->dev;
943	struct brcmuart_priv *priv;
944	struct clk *baud_mux_clk;
945	struct uart_8250_port up;
946	int irq;
947	void __iomem *membase = NULL;
948	resource_size_t mapbase = 0;
949	u32 clk_rate = 0;
950	int ret;
951	int x;
952	int dma_irq;
953	static const char * const reg_names[REGS_MAX] = {
954		"uart", "dma_rx", "dma_tx", "dma_intr2", "dma_arb"
955	};
956
957	irq = platform_get_irq(pdev, 0);
958	if (irq < 0)
959		return irq;
960	priv = devm_kzalloc(dev, sizeof(struct brcmuart_priv),
961			GFP_KERNEL);
962	if (!priv)
963		return -ENOMEM;
964
965	of_id = of_match_node(brcmuart_dt_ids, np);
966	if (!of_id || !of_id->data)
967		priv->rate_table = brcmstb_rate_table;
968	else
969		priv->rate_table = of_id->data;
970
971	for (x = 0; x < REGS_MAX; x++) {
972		regs = platform_get_resource_byname(pdev, IORESOURCE_MEM,
973						reg_names[x]);
974		if (!regs)
975			break;
976		priv->regs[x] =	devm_ioremap(dev, regs->start,
977					     resource_size(regs));
978		if (!priv->regs[x])
979			return -ENOMEM;
980		if (x == REGS_8250) {
981			mapbase = regs->start;
982			membase = priv->regs[x];
983		}
984	}
985
986	/* We should have just the uart base registers or all the registers */
987	if (x != 1 && x != REGS_MAX) {
988		dev_warn(dev, "%s registers not specified\n", reg_names[x]);
989		return -EINVAL;
990	}
991
992	/* if the DMA registers were specified, try to enable DMA */
993	if (x > REGS_DMA_RX) {
994		if (brcmuart_arbitration(priv, 1) == 0) {
995			u32 txrev = 0;
996			u32 rxrev = 0;
997
998			txrev = udma_readl(priv, REGS_DMA_RX, UDMA_RX_REVISION);
999			rxrev = udma_readl(priv, REGS_DMA_TX, UDMA_TX_REVISION);
1000			if ((txrev >= UDMA_TX_REVISION_REQUIRED) &&
1001				(rxrev >= UDMA_RX_REVISION_REQUIRED)) {
1002
1003				/* Enable the use of the DMA hardware */
1004				priv->dma_enabled = true;
1005			} else {
1006				brcmuart_arbitration(priv, 0);
1007				dev_err(dev,
1008					"Unsupported DMA Hardware Revision\n");
1009			}
1010		} else {
1011			dev_err(dev,
1012				"Timeout arbitrating for UART DMA hardware\n");
1013		}
1014	}
1015
1016	of_property_read_u32(np, "clock-frequency", &clk_rate);
1017
1018	/* See if a Baud clock has been specified */
1019	baud_mux_clk = devm_clk_get(dev, "sw_baud");
1020	if (IS_ERR(baud_mux_clk)) {
1021		if (PTR_ERR(baud_mux_clk) == -EPROBE_DEFER) {
1022			ret = -EPROBE_DEFER;
1023			goto release_dma;
1024		}
1025		dev_dbg(dev, "BAUD MUX clock not specified\n");
1026	} else {
1027		dev_dbg(dev, "BAUD MUX clock found\n");
1028		ret = clk_prepare_enable(baud_mux_clk);
1029		if (ret)
1030			goto release_dma;
1031		priv->baud_mux_clk = baud_mux_clk;
1032		init_real_clk_rates(dev, priv);
1033		clk_rate = priv->default_mux_rate;
1034	}
1035
1036	if (clk_rate == 0) {
1037		dev_err(dev, "clock-frequency or clk not defined\n");
1038		ret = -EINVAL;
1039		goto err_clk_disable;
1040	}
1041
1042	dev_dbg(dev, "DMA is %senabled\n", priv->dma_enabled ? "" : "not ");
1043
1044	memset(&up, 0, sizeof(up));
1045	up.port.type = PORT_BCM7271;
1046	up.port.uartclk = clk_rate;
1047	up.port.dev = dev;
1048	up.port.mapbase = mapbase;
1049	up.port.membase = membase;
1050	up.port.irq = irq;
1051	up.port.handle_irq = brcmuart_handle_irq;
1052	up.port.regshift = 2;
1053	up.port.iotype = of_device_is_big_endian(np) ?
1054		UPIO_MEM32BE : UPIO_MEM32;
1055	up.port.flags = UPF_SHARE_IRQ | UPF_BOOT_AUTOCONF
1056		| UPF_FIXED_PORT | UPF_FIXED_TYPE;
1057	up.port.dev = dev;
1058	up.port.private_data = priv;
1059
1060	/* Check for a fixed line number */
1061	ret = of_alias_get_id(np, "serial");
1062	if (ret >= 0)
1063		up.port.line = ret;
1064
1065	/* setup HR timer */
1066	hrtimer_init(&priv->hrt, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
1067	priv->hrt.function = brcmuart_hrtimer_func;
1068
1069	up.port.shutdown = brcmuart_shutdown;
1070	up.port.startup = brcmuart_startup;
1071	up.port.throttle = brcmuart_throttle;
1072	up.port.unthrottle = brcmuart_unthrottle;
1073	up.port.set_termios = brcmstb_set_termios;
1074
1075	if (priv->dma_enabled) {
1076		priv->rx_size = RX_BUF_SIZE * RX_BUFS_COUNT;
1077		priv->rx_bufs = dma_alloc_coherent(dev,
1078						   priv->rx_size,
1079						   &priv->rx_addr, GFP_KERNEL);
1080		if (!priv->rx_bufs) {
1081			ret = -ENOMEM;
1082			goto err;
1083		}
1084		priv->tx_size = UART_XMIT_SIZE;
1085		priv->tx_buf = dma_alloc_coherent(dev,
1086						  priv->tx_size,
1087						  &priv->tx_addr, GFP_KERNEL);
1088		if (!priv->tx_buf) {
1089			ret = -ENOMEM;
1090			goto err;
1091		}
1092	}
1093
1094	ret = serial8250_register_8250_port(&up);
1095	if (ret < 0) {
1096		dev_err(dev, "unable to register 8250 port\n");
1097		goto err;
1098	}
1099	priv->line = ret;
1100	new_port = serial8250_get_port(ret);
1101	priv->up = &new_port->port;
1102	if (priv->dma_enabled) {
1103		dma_irq = platform_get_irq_byname(pdev,  "dma");
1104		if (dma_irq < 0) {
1105			ret = dma_irq;
1106			dev_err(dev, "no IRQ resource info\n");
1107			goto err1;
1108		}
1109		ret = devm_request_irq(dev, dma_irq, brcmuart_isr,
1110				IRQF_SHARED, "uart DMA irq", &new_port->port);
1111		if (ret) {
1112			dev_err(dev, "unable to register IRQ handler\n");
1113			goto err1;
1114		}
1115	}
1116	platform_set_drvdata(pdev, priv);
1117	brcmuart_init_debugfs(priv, dev_name(&pdev->dev));
1118	return 0;
1119
1120err1:
1121	serial8250_unregister_port(priv->line);
1122err:
1123	brcmuart_free_bufs(dev, priv);
1124err_clk_disable:
1125	clk_disable_unprepare(baud_mux_clk);
1126release_dma:
1127	if (priv->dma_enabled)
1128		brcmuart_arbitration(priv, 0);
1129	return ret;
1130}
1131
1132static int brcmuart_remove(struct platform_device *pdev)
1133{
1134	struct brcmuart_priv *priv = platform_get_drvdata(pdev);
1135
1136	debugfs_remove_recursive(priv->debugfs_dir);
1137	hrtimer_cancel(&priv->hrt);
1138	serial8250_unregister_port(priv->line);
1139	brcmuart_free_bufs(&pdev->dev, priv);
1140	clk_disable_unprepare(priv->baud_mux_clk);
1141	if (priv->dma_enabled)
1142		brcmuart_arbitration(priv, 0);
1143	return 0;
1144}
1145
1146static int __maybe_unused brcmuart_suspend(struct device *dev)
1147{
1148	struct brcmuart_priv *priv = dev_get_drvdata(dev);
1149	struct uart_8250_port *up = serial8250_get_port(priv->line);
1150	struct uart_port *port = &up->port;
1151	unsigned long flags;
1152
1153	/*
1154	 * This will prevent resume from enabling RTS before the
1155	 *  baud rate has been restored.
1156	 */
1157	spin_lock_irqsave(&port->lock, flags);
1158	priv->saved_mctrl = port->mctrl;
1159	port->mctrl &= ~TIOCM_RTS;
1160	spin_unlock_irqrestore(&port->lock, flags);
1161
1162	serial8250_suspend_port(priv->line);
1163	clk_disable_unprepare(priv->baud_mux_clk);
1164
1165	return 0;
1166}
1167
1168static int __maybe_unused brcmuart_resume(struct device *dev)
1169{
1170	struct brcmuart_priv *priv = dev_get_drvdata(dev);
1171	struct uart_8250_port *up = serial8250_get_port(priv->line);
1172	struct uart_port *port = &up->port;
1173	unsigned long flags;
1174	int ret;
1175
1176	ret = clk_prepare_enable(priv->baud_mux_clk);
1177	if (ret)
1178		dev_err(dev, "Error enabling BAUD MUX clock\n");
1179
1180	/*
1181	 * The hardware goes back to it's default after suspend
1182	 * so get the "clk" back in sync.
1183	 */
1184	ret = clk_set_rate(priv->baud_mux_clk, priv->default_mux_rate);
1185	if (ret)
1186		dev_err(dev, "Error restoring default BAUD MUX clock\n");
1187	if (priv->dma_enabled) {
1188		if (brcmuart_arbitration(priv, 1)) {
1189			dev_err(dev, "Timeout arbitrating for DMA hardware on resume\n");
1190			return(-EBUSY);
1191		}
1192		brcmuart_init_dma_hardware(priv);
1193		start_rx_dma(serial8250_get_port(priv->line));
1194	}
1195	serial8250_resume_port(priv->line);
1196
1197	if (priv->saved_mctrl & TIOCM_RTS) {
1198		/* Restore RTS */
1199		spin_lock_irqsave(&port->lock, flags);
1200		port->mctrl |= TIOCM_RTS;
1201		port->ops->set_mctrl(port, port->mctrl);
1202		spin_unlock_irqrestore(&port->lock, flags);
1203	}
1204
1205	return 0;
1206}
1207
1208static const struct dev_pm_ops brcmuart_dev_pm_ops = {
1209	SET_SYSTEM_SLEEP_PM_OPS(brcmuart_suspend, brcmuart_resume)
1210};
1211
1212static struct platform_driver brcmuart_platform_driver = {
1213	.driver = {
1214		.name	= "bcm7271-uart",
1215		.pm		= &brcmuart_dev_pm_ops,
1216		.of_match_table = brcmuart_dt_ids,
1217	},
1218	.probe		= brcmuart_probe,
1219	.remove		= brcmuart_remove,
1220};
1221
1222static int __init brcmuart_init(void)
1223{
1224	int ret;
1225
1226	brcmuart_debugfs_root = debugfs_create_dir(
1227		brcmuart_platform_driver.driver.name, NULL);
1228	ret = platform_driver_register(&brcmuart_platform_driver);
1229	if (ret) {
1230		debugfs_remove_recursive(brcmuart_debugfs_root);
1231		return ret;
1232	}
1233
1234	return 0;
1235}
1236module_init(brcmuart_init);
1237
1238static void __exit brcmuart_deinit(void)
1239{
1240	platform_driver_unregister(&brcmuart_platform_driver);
1241	debugfs_remove_recursive(brcmuart_debugfs_root);
1242}
1243module_exit(brcmuart_deinit);
1244
1245MODULE_AUTHOR("Al Cooper");
1246MODULE_DESCRIPTION("Broadcom NS16550A compatible serial port driver");
1247MODULE_LICENSE("GPL v2");
1248