spi/spi-xilinx: Fix race condition on last word read

Some users have reported that in polled mode the driver fails randomly
to read the last word of the transfer.

The end condition used for the transmissions (in polled and irq mode)
has been the TX_EMPTY flag. But Lars-Peter Clausen has identified a delay
from the TX_EMPTY to the actual end of the data rx.

I believe that this race condition has not been detected until now
because of the latency added by the IRQ handler or the PCIe bridge.
This bugs affects setups with low latency access to the spi core.

This patch replaces the readout logic:

For all the words, except the last one, the TX_EMPTY flag is used (and
cached).

If !TX_EMPY or is the last word. The status register is read and the
RX_EMPTY flag is used.

The performance is not affected: there is an extra read of the
Status Register, but the readout can start as soon as there is a word
in the buffer.

Reported-by: Edward Kigwana <ekigwana@scires.com>
Initial-fix-by: Lars-Peter Clausen <lars@metafoo.de>
Signed-off-by: Ricardo Ribalda Delgado <ricardo.ribalda@gmail.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
Cc: stable@vger.kernel.org

diff --git a/drivers/spi/spi-xilinx.c b/drivers/spi/spi-xilinx.c
index a339c1e9997a93a431cf5ce9be5947b6333ac3e9..3009121173cdbc9ad1a0537a4cf19a029ceb86b8 100644 (file)
--- a/drivers/spi/spi-xilinx.c
+++ b/drivers/spi/spi-xilinx.c
@@ -270,6 +270,7 @@ static int xilinx_spi_txrx_bufs(struct spi_device *spi, struct spi_transfer *t)
 
        while (remaining_words) {
                int n_words, tx_words, rx_words;
+               u32 sr;
 
                n_words = min(remaining_words, xspi->buffer_size);
 
@@ -284,24 +285,33 @@ static int xilinx_spi_txrx_bufs(struct spi_device *spi, struct spi_transfer *t)
                if (use_irq) {
                        xspi->write_fn(cr, xspi->regs + XSPI_CR_OFFSET);
                        wait_for_completion(&xspi->done);
-               } else
-                       while (!(xspi->read_fn(xspi->regs + XSPI_SR_OFFSET) &
-                                               XSPI_SR_TX_EMPTY_MASK))
-                               ;
-
-               /* A transmit has just completed. Process received data and
-                * check for more data to transmit. Always inhibit the
-                * transmitter while the Isr refills the transmit register/FIFO,
-                * or make sure it is stopped if we're done.
-                */
-               if (use_irq)
+                       /* A transmit has just completed. Process received data
+                        * and check for more data to transmit. Always inhibit
+                        * the transmitter while the Isr refills the transmit
+                        * register/FIFO, or make sure it is stopped if we're
+                        * done.
+                        */
                        xspi->write_fn(cr | XSPI_CR_TRANS_INHIBIT,
-                              xspi->regs + XSPI_CR_OFFSET);
+                                      xspi->regs + XSPI_CR_OFFSET);
+                       sr = XSPI_SR_TX_EMPTY_MASK;
+               } else
+                       sr = xspi->read_fn(xspi->regs + XSPI_SR_OFFSET);
 
                /* Read out all the data from the Rx FIFO */
                rx_words = n_words;
-               while (rx_words--)
-                       xilinx_spi_rx(xspi);
+               while (rx_words) {
+                       if ((sr & XSPI_SR_TX_EMPTY_MASK) && (rx_words > 1)) {
+                               xilinx_spi_rx(xspi);
+                               rx_words--;
+                               continue;
+                       }
+
+                       sr = xspi->read_fn(xspi->regs + XSPI_SR_OFFSET);
+                       if (!(sr & XSPI_SR_RX_EMPTY_MASK)) {
+                               xilinx_spi_rx(xspi);
+                               rx_words--;
+                       }
+               }
 
                remaining_words -= n_words;
        }