i2c: xlp9xx: Fix case where SSIF read transaction completes early [Linux 4.18]

This Linux kernel change "i2c: xlp9xx: Fix case where SSIF read transaction completes early" is included in the Linux 4.18 release. This change is authored by George Cherian <george.cherian [at] cavium.com> on Wed Aug 8 23:36:48 2018 -0700. The commit for this change in Linux stable tree is 5eb173f (patch).

i2c: xlp9xx: Fix case where SSIF read transaction completes early

During ipmi stress tests we see occasional failure of transactions
at the boot time. This happens in the case of a I2C_M_RECV_LEN
transactions, when the read transfer completes (with the initial
read length of 34) before the driver gets a chance to handle interrupts.

The current driver code expects at least 2 interrupts for I2C_M_RECV_LEN
transactions. The length is updated during the first interrupt, and  the
buffer contents are only copied during subsequent interrupts. In case of
just one interrupt, we will complete the transaction without copying
out the bytes from RX fifo.

Update the code to drain the RX fifo after the length update,
so that the transaction completes correctly in all cases.

Signed-off-by: George Cherian <[email protected]>
Signed-off-by: Wolfram Sang <[email protected]>
Cc: [email protected]

There are 41 lines of Linux source code added/deleted in this change. Code changes to Linux kernel are as follows.

 drivers/i2c/busses/i2c-xlp9xx.c | 41 ++++++++++++++++++++++++++++-------------
 1 file changed, 28 insertions(+), 13 deletions(-)

diff --git a/drivers/i2c/busses/i2c-xlp9xx.c b/drivers/i2c/busses/i2c-xlp9xx.c
index 1f41a4f..8a87397 100644
--- a/drivers/i2c/busses/i2c-xlp9xx.c
+++ b/drivers/i2c/busses/i2c-xlp9xx.c
@@ -191,28 +191,43 @@ static void xlp9xx_i2c_drain_rx_fifo(struct xlp9xx_i2c_dev *priv)
    if (priv->len_recv) {
        /* read length byte */
        rlen = xlp9xx_read_i2c_reg(priv, XLP9XX_I2C_MRXFIFO);
+
+       /*
+        * We expect at least 2 interrupts for I2C_M_RECV_LEN
+        * transactions. The length is updated during the first
+        * interrupt, and the buffer contents are only copied
+        * during subsequent interrupts. If in case the interrupts
+        * get merged we would complete the transaction without
+        * copying out the bytes from RX fifo. To avoid this now we
+        * drain the fifo as and when data is available.
+        * We drained the rlen byte already, decrement total length
+        * by one.
+        */
+
+       len--;
        if (rlen > I2C_SMBUS_BLOCK_MAX || rlen == 0) {
            rlen = 0;   /*abort transfer */
            priv->msg_buf_remaining = 0;
            priv->msg_len = 0;
-       } else {
-           *buf++ = rlen;
-           if (priv->client_pec)
-               ++rlen; /* account for error check byte */
-           /* update remaining bytes and message length */
-           priv->msg_buf_remaining = rlen;
-           priv->msg_len = rlen + 1;
+           xlp9xx_i2c_update_rlen(priv);
+           return;
        }
+
+       *buf++ = rlen;
+       if (priv->client_pec)
+           ++rlen; /* account for error check byte */
+       /* update remaining bytes and message length */
+       priv->msg_buf_remaining = rlen;
+       priv->msg_len = rlen + 1;
        xlp9xx_i2c_update_rlen(priv);
        priv->len_recv = false;
-   } else {
-       len = min(priv->msg_buf_remaining, len);
-       for (i = 0; i < len; i++, buf++)
-           *buf = xlp9xx_read_i2c_reg(priv, XLP9XX_I2C_MRXFIFO);
-
-       priv->msg_buf_remaining -= len;
    }

+   len = min(priv->msg_buf_remaining, len);
+   for (i = 0; i < len; i++, buf++)
+       *buf = xlp9xx_read_i2c_reg(priv, XLP9XX_I2C_MRXFIFO);
+
+   priv->msg_buf_remaining -= len;
    priv->msg_buf = buf;

    if (priv->msg_buf_remaining)

Leave a Reply

Your email address will not be published. Required fields are marked *