[PATCH] serial: imx: Correct comment imx_flush_buffer()

[PATCH] serial: imx: Correct comment imx_flush_buffer()

[Martyn Welch]

The comment in imx_flush_buffer() states that the state of 4 registers
are to be saved/restored, then only saves and restores 3 registers. The
missing register (UBRC) is read only and thus can't be restored.

Update the comment to reflect reality.

Signed-off-by: Martyn Welch <martyn.welch@collabora.co.uk>
---
 drivers/tty/serial/imx.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/drivers/tty/serial/imx.c b/drivers/tty/serial/imx.c
index 474b5bc..63f544e 100644
--- a/drivers/tty/serial/imx.c
+++ b/drivers/tty/serial/imx.c
@@ -1415,10 +1415,14 @@ static void imx_flush_buffer(struct uart_port *port)
 
 	/*
 	 * According to the Reference Manual description of the UART SRST bit:
+	 * 
 	 * "Reset the transmit and receive state machines,
 	 * all FIFOs and register USR1, USR2, UBIR, UBMR, UBRC, URXD, UTXD
-	 * and UTS[6-3]". As we don't need to restore the old values from
-	 * USR1, USR2, URXD, UTXD, only save/restore the other four registers
+	 * and UTS[6-3]".
+	 * 
+	 * We don't need to restore the old values from USR1, USR2, URXD and
+	 * UTXD. UBRC is read only, so only save/restore the other three 
+	 * registers.
 	 */
 	ubir = readl(sport->port.membase + UBIR);
 	ubmr = readl(sport->port.membase + UBMR);
-- 
1.8.3.1

Re: [PATCH] serial: imx: Correct comment imx_flush_buffer()

[Greg Kroah-Hartman]

On Fri, Sep 29, 2017 at 10:22:19AM +0100, Martyn Welch wrote:
> The comment in imx_flush_buffer() states that the state of 4 registers
> are to be saved/restored, then only saves and restores 3 registers. The
> missing register (UBRC) is read only and thus can't be restored.
> 
> Update the comment to reflect reality.

Always run checkpatch.pl so you don't get grumpy maintainers telling you
to run checkpatch.pl :(

Re: [PATCH] serial: imx: Correct comment imx_flush_buffer()

[Martyn Welch]

On Tue, 2017-10-03 at 20:27 +0200, Greg Kroah-Hartman wrote:
> On Fri, Sep 29, 2017 at 10:22:19AM +0100, Martyn Welch wrote:
> > The comment in imx_flush_buffer() states that the state of 4 registers
> > are to be saved/restored, then only saves and restores 3 registers. The
> > missing register (UBRC) is read only and thus can't be restored.
> > 
> > Update the comment to reflect reality.
> 
> Always run checkpatch.pl so you don't get grumpy maintainers telling you
> to run checkpatch.pl :(

Sorry Greg, must have got out of sync on that one :-(

Martyn