Skip to contentSkip to conversation

serial: mxs-auart: wait for DMA buffer to flush before shutdown

PATCH New Hector Palacios 4 participants 6 messages Oct 3, 2013 – Oct 16, 2013

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

v3 cover serial: mxs-auart: wait for DMA buffer to flush before shutdown

This fixes a bug whereby the AUART was shutdown while bytes were still waiting in the DMA buffer to be transmistted.

Changes since v2:
* Added Reviewed/Acked-by tags to first commit.
* Move tx_empty callback up to avoid forward declaration.
* Move BUSY flag check to tx_empty callback to avoid check on shutdown call.

Changes since v1:
* Split the patch in two: one to set the fifosize to the DMA buffer size, and another to wait for the FIFO to empty before disabling the AUART.
* The wait for the fifo to empty is now independent of DMA being enabled.
* Fix bug on readl() call
* Remove bad URL in commit log

Hector Palacios (2):
serial: mxs-auart: set the FIFO size to DMA buffer size
serial: mxs-auart: wait for FIFO to flush before shutdown

 drivers/tty/serial/mxs-auart.c | 34 +++++++++++++++++++++++++---------
 1 file changed, 25 insertions(+), 9 deletions(-)
Signature · 1 line
1.8.4
#1 lore raw

PATCH v3 1/2 serial: mxs-auart: set the FIFO size to DMA buffer size

When DMA is enabled (with hardware flow control enabled) the FIFO size must be set to the size of the DMA buffer, as this is the size the tty subsystem can use.

---
 drivers/tty/serial/mxs-auart.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
drivers/tty/serial/mxs-auart.c +8 -1
index f85b8e6..9f046177 100644
@@ -40,6 +40,7 @@
 #include <asm/cacheflush.h>
 
 #define MXS_AUART_PORTS 5
+#define MXS_AUART_FIFO_SIZE		16
 
 #define AUART_CTRL0			0x00000000
 #define AUART_CTRL0_SET			0x00000004
@@ -549,6 +550,9 @@ static int mxs_auart_dma_init(struct mxs_auart_port *s)
 	s->flags |= MXS_AUART_DMA_ENABLED;
 	dev_dbg(s->dev, "enabled the DMA support.");
 
+	/* The DMA buffer is now the FIFO the TTY subsystem can use */
+	s->port.fifosize = UART_XMIT_SIZE;
+
 	return 0;
 
 err_out:
@@ -741,6 +745,9 @@ static int mxs_auart_startup(struct uart_port *u)
 	writel(AUART_INTR_RXIEN | AUART_INTR_RTIEN | AUART_INTR_CTSMIEN,
 			u->membase + AUART_INTR);
 
+	/* Reset FIFO size (it could have changed if DMA was enabled) */
+	u->fifosize = MXS_AUART_FIFO_SIZE;
+
 	/*
 	 * Enable fifo so all four bytes of a DMA word are written to
 	 * output (otherwise, only the LSB is written, ie. 1 in 4 bytes)
@@ -1062,7 +1069,7 @@ static int mxs_auart_probe(struct platform_device *pdev)
 	s->port.membase = ioremap(r->start, resource_size(r));
 	s->port.ops = &mxs_auart_ops;
 	s->port.iotype = UPIO_MEM;
-	s->port.fifosize = 16;
+	s->port.fifosize = MXS_AUART_FIFO_SIZE;
 	s->port.uartclk = clk_get_rate(s->clk);
 	s->port.type = PORT_IMX;
 	s->port.dev = s->dev = &pdev->dev;
Signature · 1 line
1.8.4
#2 lore raw

PATCH v3 2/2 serial: mxs-auart: wait for FIFO to flush before shutdown

In reply to Hector Palacios

The shutdown function was not waiting for the FIFO (which may be the real 16 byte FIFO or the DMA buffer, if DMA is enabled) to flush before disabling the AUART.
This lead to many bytes not being transferred (specially at low baudrates), as they were still in the DMA buffer when the AUART was shutdown.
This patch also adds the check for the BUSY flag on the tx_empty callback.

---
 drivers/tty/serial/mxs-auart.c | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)
drivers/tty/serial/mxs-auart.c +17 -8
index 9f046177..30edb91 100644
@@ -757,9 +757,26 @@ static int mxs_auart_startup(struct uart_port *u)
 	return 0;
 }
 
+static unsigned int mxs_auart_tx_empty(struct uart_port *u)
+{
+	unsigned long stat;
+
+	stat = readl(u->membase + AUART_STAT);
+	if ((stat & (AUART_STAT_BUSY | AUART_STAT_TXFE)) == AUART_STAT_TXFE)
+		return TIOCSER_TEMT;
+
+	return 0;
+}
+
 static void mxs_auart_shutdown(struct uart_port *u)
 {
 	struct mxs_auart_port *s = to_auart_port(u);
+	unsigned int to;
+
+	/* Wait for the FIFO to flush */
+	to = u->timeout;
+	while (!mxs_auart_tx_empty(u) && to--)
+		mdelay(1);
 
 	if (auart_dma_enabled(s))
 		mxs_auart_dma_exit(s);
@@ -774,14 +791,6 @@ static void mxs_auart_shutdown(struct uart_port *u)
 	clk_disable_unprepare(s->clk);
 }
 
-static unsigned int mxs_auart_tx_empty(struct uart_port *u)
-{
-	if (readl(u->membase + AUART_STAT) & AUART_STAT_TXFE)
-		return TIOCSER_TEMT;
-	else
-		return 0;
-}
-
 static void mxs_auart_start_tx(struct uart_port *u)
 {
 	struct mxs_auart_port *s = to_auart_port(u);
Signature · 1 line
1.8.4
#3 lore raw

PATCH v3 2/2 serial: mxs-auart: wait for FIFO to flush before shutdown

Hello,

there is only a single concern left and probably only the Freescale guys can comment here ...

Quoted 19 lines · Hector Palacios

The shutdown function was not waiting for the FIFO (which may be the real 16 byte FIFO or the DMA buffer, if DMA is enabled) to flush before disabling the AUART.
This lead to many bytes not being transferred (specially at low baudrates), as they were still in the DMA buffer when the AUART was shutdown.
This patch also adds the check for the BUSY flag on the tx_empty callback.

---
 drivers/tty/serial/mxs-auart.c | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)
drivers/tty/serial/mxs-auart.c +0 -0
index 9f046177..30edb91 100644

drivers/tty/serial/mxs-auart.c static int mxs_auart_startup(struct uart_port *u) · line 766

Quoted 10 lines
drivers/tty/serial/mxs-auart.c +7 -0
@@ -757,9 +757,26 @@ static int mxs_auart_startup(struct uart_port *u)
 	return 0;
 }
 
+static unsigned int mxs_auart_tx_empty(struct uart_port *u)
+{
+	unsigned long stat;
+
+	stat = readl(u->membase + AUART_STAT);
+	if ((stat & (AUART_STAT_BUSY | AUART_STAT_TXFE)) == AUART_STAT_TXFE)
+		return TIOCSER_TEMT;

Can it happen that both the fifo and the shifter are empty but there are still some chars pending to be transfered via DMA? If you were checking if dma is still setup you'd be on the safe side.

Best regards
Uwe

Quoted 35 lines
drivers/tty/serial/mxs-auart.c +10 -8
+
+	return 0;
+}
+
 static void mxs_auart_shutdown(struct uart_port *u)
 {
 	struct mxs_auart_port *s = to_auart_port(u);
+	unsigned int to;
+
+	/* Wait for the FIFO to flush */
+	to = u->timeout;
+	while (!mxs_auart_tx_empty(u) && to--)
+		mdelay(1);
 
 	if (auart_dma_enabled(s))
 		mxs_auart_dma_exit(s);
@@ -774,14 +791,6 @@ static void mxs_auart_shutdown(struct uart_port *u)
 	clk_disable_unprepare(s->clk);
 }
 
-static unsigned int mxs_auart_tx_empty(struct uart_port *u)
-{
-	if (readl(u->membase + AUART_STAT) & AUART_STAT_TXFE)
-		return TIOCSER_TEMT;
-	else
-		return 0;
-}
-
 static void mxs_auart_start_tx(struct uart_port *u)
 {
 	struct mxs_auart_port *s = to_auart_port(u);
Signature · 1 line
1.8.4
Signature · 2 lines
Pengutronix e.K.                           | Uwe Kleine-K?nig            |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
maintainer
#4 lore raw

PATCH v3 2/2 serial: mxs-auart: wait for FIFO to flush before shutdown

Quoted 27 lines · Uwe Kleine-K?nig

Hello,

there is only a single concern left and probably only the Freescale guys can comment here ...

Quoted 22 lines · Hector Palacios

The shutdown function was not waiting for the FIFO (which may be the real 16 byte FIFO or the DMA buffer, if DMA is enabled) to flush before disabling the AUART.
This lead to many bytes not being transferred (specially at low baudrates), as they were still in the DMA buffer when the AUART was shutdown.
This patch also adds the check for the BUSY flag on the tx_empty callback.

---
 drivers/tty/serial/mxs-auart.c | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)
drivers/tty/serial/mxs-auart.c +0 -0
index 9f046177..30edb91 100644
@@ -757,9 +757,26 @@ static int mxs_auart_startup(struct uart_port *u)
 	return 0;
 }
 
Quoted 10 lines

drivers/tty/serial/mxs-auart.c static int mxs_auart_startup(struct uart_port *u) · line 766

Quoted 7 lines
drivers/tty/serial/mxs-auart.c +7 -0
+static unsigned int mxs_auart_tx_empty(struct uart_port *u)
+{
+	unsigned long stat;
+
+	stat = readl(u->membase + AUART_STAT);
+	if ((stat & (AUART_STAT_BUSY | AUART_STAT_TXFE)) == AUART_STAT_TXFE)
+		return TIOCSER_TEMT;

Can it happen that both the fifo and the shifter are empty but there are still some chars pending to be transfered via DMA? If you were checking if dma is still setup you'd be on the safe side.

I'm deleting this from my queue until this gets resolved. Someone please resend it when it does.

thanks,

greg k-h

#5 lore raw

PATCH v3 2/2 serial: mxs-auart: wait for FIFO to flush before shutdown

In reply to Hector Palacios
Quoted 3 lines · Hector Palacios

This lead to many bytes not being transferred (specially at low baudrates), as they were still in the DMA buffer when the AUART was shutdown.

I meet a similar bug with the imx.c which is used for the I.MX.

I did not implement the uart_ops->flush_buffer() hook, so the DMA may fails.

So could we add a new flush_buffer hook for mxs-auart?

Please see the Documentation/serail/driver.

thanks
Huang Shijie

--
To unsubscribe from this list: send the line "unsubscribe linux-serial" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html