Skip to contentSkip to conversation

serial: mxc: Wait for TX completion before reset

PATCH In review Loic Poulain 4 participants 8 messages Jan 12, 2023 – Jan 31, 2023

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/2 serial: mxc: Wait for TX completion before reset

The u-boot console may show some corrupted characters when printing in board_init() due to reset or baudrate change of the UART (probe) before the TX FIFO has been completely drained.

To fix this issue, and in case UART is still running, we now try to flush the FIFO before proceeding to UART reinitialization. For this we're waiting for Transmitter Complete bit, indicating that the FIFO and the shift register are empty.

flushing has a 4ms timeout guard, which is normally more than enough to consume the FIFO @ low baudrate (9600bps).

---
 v2: Add this commit to the series
v3: Fix typo & reordering commits for good bisectabilit
v4: Wait for transfer completion before baudrate change as well

 drivers/serial/serial_mxc.c | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)
drivers/serial/serial_mxc.c +25 -1
index 82c0d84628..9e5b987994 100644
@@ -13,6 +13,7 @@
 #include <dm/platform_data/serial_mxc.h>
 #include <serial.h>
 #include <linux/compiler.h>
+#include <linux/delay.h>
 
 /* UART Control Register Bit Fields.*/
 #define URXD_CHARRDY	(1<<15)
@@ -144,8 +145,22 @@ struct mxc_uart {
 	u32 ts;
 };
 
+static void _mxc_serial_flush(struct mxc_uart *base)
+{
+	unsigned int timeout = 4000;
+
+	if (!(readl(&base->cr1) & UCR1_UARTEN) ||
+	    !(readl(&base->cr2) & UCR2_TXEN))
+		return;
+
+	while (!(readl(&base->sr2) & USR2_TXDC) && --timeout)
+		udelay(1);
+}
+
 static void _mxc_serial_init(struct mxc_uart *base, int use_dte)
 {
+	_mxc_serial_flush(base);
+
 	writel(0, &base->cr1);
 	writel(0, &base->cr2);
 
@@ -169,6 +184,8 @@ static void _mxc_serial_setbrg(struct mxc_uart *base, unsigned long clk,
 {
 	u32 tmp;
 
+	_mxc_serial_flush(base);
+
 	tmp = RFDIV << UFCR_RFDIV_SHF;
 	if (use_dte)
 		tmp |= UFCR_DCEDTE;
@@ -252,10 +269,17 @@ static int mxc_serial_init(void)
 	return 0;
 }
 
+static int mxc_serial_stop(void)
+{
+	_mxc_serial_flush(mxc_base);
+
+	return 0;
+}
+
 static struct serial_device mxc_serial_drv = {
 	.name	= "mxc_serial",
 	.start	= mxc_serial_init,
-	.stop	= NULL,
+	.stop	= mxc_serial_stop,
 	.setbrg	= mxc_serial_setbrg,
 	.putc	= mxc_serial_putc,
 	.puts	= default_serial_puts,
Signature · 1 line
2.34.1
#1 lore raw

PATCH v4 2/2 serial: mxc: Speed-up character transmission

Instead of waiting for empty FIFO condition before writing a character, wait for non-full FIFO condition.

This helps in saving several tens of milliseconds during boot (depending verbosity).

---
v2: fixing transfert abort & char corruption commit
v3: Reordering commits for good bisectability
v4: no code change

 drivers/serial/serial_mxc.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
drivers/serial/serial_mxc.c +4 -4
index 9e5b987994..cac1922354 100644
@@ -240,11 +240,11 @@ static void mxc_serial_putc(const char c)
 	if (c == '\n')
 		serial_putc('\r');
 
-	writel(c, &mxc_base->txd);
-
 	/* wait for transmitter to be ready */
-	while (!(readl(&mxc_base->ts) & UTS_TXEMPTY))
+	while (readl(&mxc_base->ts) & UTS_TXFULL)
 		schedule();
+
+	writel(c, &mxc_base->txd);
 }
 
 /* Test whether a character is in the RX buffer */
@@ -335,7 +335,7 @@ static int mxc_serial_putc(struct udevice *dev, const char ch)
 	struct mxc_serial_plat *plat = dev_get_plat(dev);
 	struct mxc_uart *const uart = plat->reg;
 
-	if (!(readl(&uart->ts) & UTS_TXEMPTY))
+	if (readl(&uart->ts) & UTS_TXFULL)
 		return -EAGAIN;
 
 	writel(ch, &uart->txd);
Signature · 1 line
2.34.1
Reviewed-by on v4 2/2
#2 lore raw

Re: [PATCH v4 2/2] serial: mxc: Speed-up character transmission

Quoted 10 lines · Loic Poulain

Instead of waiting for empty FIFO condition before writing a character, wait for non-full FIFO condition.

This helps in saving several tens of milliseconds during boot (depending verbosity).

Tested-by
#3 lore raw

Re: [PATCH v4 2/2] serial: mxc: Speed-up character transmission

Quoted 6 lines · Fabio Estevam
Quoted 4 lines · Loic Poulain

Instead of waiting for empty FIFO condition before writing a character, wait for non-full FIFO condition.

Quoted 8 lines
Quoted 6 lines

This helps in saving several tens of milliseconds during boot (depending verbosity).

Also tested on an imx8mm-evk board by printing inside board_init().

No more corruption is seen like the one we observed during Johannes' attempt last time:

Nice work, Loic!

#4 lore raw

PATCH v4 2/2 serial: mxc: Speed-up character transmission

In reply to Loic Poulain
Quoted 9 lines

Instead of waiting for empty FIFO condition before writing a character, wait for non-full FIFO condition.
This helps in saving several tens of milliseconds during boot (depending verbosity).

Applied to u-boot-imx, master, thanks !

Best regards,
Stefano Babic

Signature · 5 lines
=====================================================================
DENX Software Engineering GmbH,        Managing Director: Erika Unter  
HRB 165235 Munich,   Office: Kirchenstr.5, 82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: [email protected]
=====================================================================
Acked-by on v4 1/2
#5 lore raw
In reply to Loic Poulain
Quoted 10 lines · On Thursday 12 January 2023 18:19:50 Loic Poulain wrote:

The u-boot console may show some corrupted characters when printing in board_init() due to reset or baudrate change of the UART (probe) before the TX FIFO has been completely drained.

To fix this issue, and in case UART is still running, we now try to flush the FIFO before proceeding to UART reinitialization. For this we're waiting for Transmitter Complete bit, indicating that the FIFO and the shift register are empty.

Quoted 5 lines

flushing has a 4ms timeout guard, which is normally more than enough to consume the FIFO @ low baudrate (9600bps).

Quoted 74 lines

---
 v2: Add this commit to the series
v3: Fix typo & reordering commits for good bisectabilit
v4: Wait for transfer completion before baudrate change as well

 drivers/serial/serial_mxc.c | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)
drivers/serial/serial_mxc.c +25 -1
index 82c0d84628..9e5b987994 100644
@@ -13,6 +13,7 @@
 #include <dm/platform_data/serial_mxc.h>
 #include <serial.h>
 #include <linux/compiler.h>
+#include <linux/delay.h>
 
 /* UART Control Register Bit Fields.*/
 #define URXD_CHARRDY	(1<<15)
@@ -144,8 +145,22 @@ struct mxc_uart {
 	u32 ts;
 };
 
+static void _mxc_serial_flush(struct mxc_uart *base)
+{
+	unsigned int timeout = 4000;
+
+	if (!(readl(&base->cr1) & UCR1_UARTEN) ||
+	    !(readl(&base->cr2) & UCR2_TXEN))
+		return;
+
+	while (!(readl(&base->sr2) & USR2_TXDC) && --timeout)
+		udelay(1);
+}
+
 static void _mxc_serial_init(struct mxc_uart *base, int use_dte)
 {
+	_mxc_serial_flush(base);
+
 	writel(0, &base->cr1);
 	writel(0, &base->cr2);
 
@@ -169,6 +184,8 @@ static void _mxc_serial_setbrg(struct mxc_uart *base, unsigned long clk,
 {
 	u32 tmp;
 
+	_mxc_serial_flush(base);
+
 	tmp = RFDIV << UFCR_RFDIV_SHF;
 	if (use_dte)
 		tmp |= UFCR_DCEDTE;
@@ -252,10 +269,17 @@ static int mxc_serial_init(void)
 	return 0;
 }
 
+static int mxc_serial_stop(void)
+{
+	_mxc_serial_flush(mxc_base);
+
+	return 0;
+}
+
 static struct serial_device mxc_serial_drv = {
 	.name	= "mxc_serial",
 	.start	= mxc_serial_init,
-	.stop	= NULL,
+	.stop	= mxc_serial_stop,
 	.setbrg	= mxc_serial_setbrg,
 	.putc	= mxc_serial_putc,
 	.puts	= default_serial_puts,
Signature · 1 line
2.34.1
Reviewed-by on v4 1/2
#6 lore raw
In reply to Loic Poulain
Quoted 11 lines · Loic Poulain

The u-boot console may show some corrupted characters when printing in board_init() due to reset or baudrate change of the UART (probe) before the TX FIFO has been completely drained.

To fix this issue, and in case UART is still running, we now try to flush the FIFO before proceeding to UART reinitialization. For this we're waiting for Transmitter Complete bit, indicating that the FIFO and the shift register are empty.

Quoted 5 lines

flushing has a 4ms timeout guard, which is normally more than enough to consume the FIFO @ low baudrate (9600bps).

#7 lore raw

PATCH v4 1/2 serial: mxc: Wait for TX completion before reset

In reply to Loic Poulain
Quoted 10 lines

The u-boot console may show some corrupted characters when printing in board_init() due to reset or baudrate change of the UART (probe) before the TX FIFO has been completely drained.
To fix this issue, and in case UART is still running, we now try to flush the FIFO before proceeding to UART reinitialization. For this we're waiting for Transmitter Complete bit, indicating that the FIFO and the shift register are empty. flushing has a 4ms timeout guard, which is normally more than enough to consume the FIFO @ low baudrate (9600bps).

Quoted 4 lines

Applied to u-boot-imx, master, thanks !

Best regards,
Stefano Babic

Signature · 5 lines
=====================================================================
DENX Software Engineering GmbH,        Managing Director: Erika Unter  
HRB 165235 Munich,   Office: Kirchenstr.5, 82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: [email protected]
=====================================================================