serial: sc16is7xx: fix TX fifo corruption

Sometimes, when a packet is received on channel A at almost the same time
as a packet is about to be transmitted on channel B, we observe with a
logic analyzer that the received packet on channel A is transmitted on
channel B. In other words, the Tx buffer data on channel B is corrupted
with data from channel A.

The problem appeared since commit 4409df5866b7 ("serial: sc16is7xx: change
EFR lock to operate on each channels"), which changed the EFR locking to
operate on each channel instead of chip-wise.

This commit has introduced a regression, because the EFR lock is used not
only to protect the EFR registers access, but also, in a very obscure and
undocumented way, to protect access to the data buffer, which is shared by
the Tx and Rx handlers, but also by each channel of the IC.

Fix this regression first by switching to kfifo_out_linear_ptr() in
sc16is7xx_handle_tx() to eliminate the need for a shared Rx/Tx buffer.

Secondly, replace the chip-wise Rx buffer with a separate Rx buffer for
each channel.

Fixes: 4409df5866b7 ("serial: sc16is7xx: change EFR lock to operate on each channels")
Cc: stable@vger.kernel.org
Signed-off-by: Hugo Villeneuve <hvilleneuve@dimonoff.com>
Link: https://lore.kernel.org/r/20240723125302.1305372-2-hugo@hugovil.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/drivers/tty/serial/sc16is7xx.c b/drivers/tty/serial/sc16is7xx.c
index c79dcd7c8d1a6032aed8ffc9bdaf7bd1623fd17a..58696e05492ca687320b67dfe8e6ae4e644f7b2e 100644 (file)
--- a/drivers/tty/serial/sc16is7xx.c
+++ b/drivers/tty/serial/sc16is7xx.c
@@ -327,6 +327,7 @@ struct sc16is7xx_one {
        struct kthread_work             reg_work;
        struct kthread_delayed_work     ms_work;
        struct sc16is7xx_one_config     config;
+       unsigned char                   buf[SC16IS7XX_FIFO_SIZE]; /* Rx buffer. */
        unsigned int                    old_mctrl;
        u8                              old_lcr; /* Value before EFR access. */
        bool                            irda_mode;
@@ -340,7 +341,6 @@ struct sc16is7xx_port {
        unsigned long                   gpio_valid_mask;
 #endif
        u8                              mctrl_mask;
-       unsigned char                   buf[SC16IS7XX_FIFO_SIZE];
        struct kthread_worker           kworker;
        struct task_struct              *kworker_task;
        struct sc16is7xx_one            p[];
@@ -612,18 +612,18 @@ static int sc16is7xx_set_baud(struct uart_port *port, int baud)
 static void sc16is7xx_handle_rx(struct uart_port *port, unsigned int rxlen,
                                unsigned int iir)
 {
-       struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
+       struct sc16is7xx_one *one = to_sc16is7xx_one(port, port);
        unsigned int lsr = 0, bytes_read, i;
        bool read_lsr = (iir == SC16IS7XX_IIR_RLSE_SRC) ? true : false;
        u8 ch, flag;
 
-       if (unlikely(rxlen >= sizeof(s->buf))) {
+       if (unlikely(rxlen >= sizeof(one->buf))) {
                dev_warn_ratelimited(port->dev,
                                     "ttySC%i: Possible RX FIFO overrun: %d\n",
                                     port->line, rxlen);
                port->icount.buf_overrun++;
                /* Ensure sanity of RX level */
-               rxlen = sizeof(s->buf);
+               rxlen = sizeof(one->buf);
        }
 
        while (rxlen) {
@@ -636,10 +636,10 @@ static void sc16is7xx_handle_rx(struct uart_port *port, unsigned int rxlen,
                        lsr = 0;
 
                if (read_lsr) {
-                       s->buf[0] = sc16is7xx_port_read(port, SC16IS7XX_RHR_REG);
+                       one->buf[0] = sc16is7xx_port_read(port, SC16IS7XX_RHR_REG);
                        bytes_read = 1;
                } else {
-                       sc16is7xx_fifo_read(port, s->buf, rxlen);
+                       sc16is7xx_fifo_read(port, one->buf, rxlen);
                        bytes_read = rxlen;
                }
 
@@ -672,7 +672,7 @@ static void sc16is7xx_handle_rx(struct uart_port *port, unsigned int rxlen,
                }
 
                for (i = 0; i < bytes_read; ++i) {
-                       ch = s->buf[i];
+                       ch = one->buf[i];
                        if (uart_handle_sysrq_char(port, ch))
                                continue;
 
@@ -690,10 +690,10 @@ static void sc16is7xx_handle_rx(struct uart_port *port, unsigned int rxlen,
 
 static void sc16is7xx_handle_tx(struct uart_port *port)
 {
-       struct sc16is7xx_port *s = dev_get_drvdata(port->dev);
        struct tty_port *tport = &port->state->port;
        unsigned long flags;
        unsigned int txlen;
+       unsigned char *tail;
 
        if (unlikely(port->x_char)) {
                sc16is7xx_port_write(port, SC16IS7XX_THR_REG, port->x_char);
@@ -718,8 +718,9 @@ static void sc16is7xx_handle_tx(struct uart_port *port)
                txlen = 0;
        }
 
-       txlen = uart_fifo_out(port, s->buf, txlen);
-       sc16is7xx_fifo_write(port, s->buf, txlen);
+       txlen = kfifo_out_linear_ptr(&tport->xmit_fifo, &tail, txlen);
+       sc16is7xx_fifo_write(port, tail, txlen);
+       uart_xmit_advance(port, txlen);
 
        uart_port_lock_irqsave(port, &flags);
        if (kfifo_len(&tport->xmit_fifo) < WAKEUP_CHARS)