Unverified Commit 6be871d5 authored by Mark Brown's avatar Mark Brown
Browse files

spi: use 'time_left' instead of 'timeout' with 

Merge series from Wolfram Sang <wsa+renesas@sang-engineering.com>:

There is a confusing pattern in the kernel to use a variable named 'timeout' to
store the result of wait_for_*() functions causing patterns like:

        timeout = wait_for_completion_timeout(...)
        if (!timeout) return -ETIMEDOUT;

with all kinds of permutations. Use 'time_left' as a variable to make the code
obvious and self explaining.

This is part of a tree-wide series. The rest of the patches can be found here
(some parts may still be WIP):

git://git.kernel.org/pub/scm/linux/kernel/git/wsa/linux.git i2c/time_left

Because these patches are generated, I audit them before sending. This is why I
will send series step by step. Build bot is happy with these patches, though.
No functional changes intended.
parents 78d94353 594aa75d

drivers/spi/spi-armada-3700.c

+4 −4
Original line number Diff line number Diff line
@@ -339,7 +339,7 @@ static irqreturn_t a3700_spi_interrupt(int irq, void *dev_id) 
static bool a3700_spi_wait_completion(struct spi_device *spi)

{

	struct a3700_spi *a3700_spi;

	unsigned int timeout;

	unsigned long time_left;

	unsigned int ctrl_reg;

	unsigned long timeout_jiffies;
@@ -361,12 +361,12 @@ static bool a3700_spi_wait_completion(struct spi_device *spi) 
		     a3700_spi->wait_mask);



	timeout_jiffies = msecs_to_jiffies(A3700_SPI_TIMEOUT);

	timeout = wait_for_completion_timeout(&a3700_spi->done,

	time_left = wait_for_completion_timeout(&a3700_spi->done,

						timeout_jiffies);



	a3700_spi->wait_mask = 0;



	if (timeout)

	if (time_left)

		return true;



	/* there might be the case that right after we checked the

drivers/spi/spi-fsl-lpspi.c

+7 −7
Original line number Diff line number Diff line
@@ -553,7 +553,7 @@ static int fsl_lpspi_dma_transfer(struct spi_controller *controller, 
{

	struct dma_async_tx_descriptor *desc_tx, *desc_rx;

	unsigned long transfer_timeout;

	unsigned long timeout;

	unsigned long time_left;

	struct sg_table *tx = &transfer->tx_sg, *rx = &transfer->rx_sg;

	int ret;
@@ -594,9 +594,9 @@ static int fsl_lpspi_dma_transfer(struct spi_controller *controller, 
							       transfer->len);



		/* Wait eDMA to finish the data transfer.*/

		timeout = wait_for_completion_timeout(&fsl_lpspi->dma_tx_completion,

		time_left = wait_for_completion_timeout(&fsl_lpspi->dma_tx_completion,

							transfer_timeout);

		if (!timeout) {

		if (!time_left) {

			dev_err(fsl_lpspi->dev, "I/O Error in DMA TX\n");

			dmaengine_terminate_all(controller->dma_tx);

			dmaengine_terminate_all(controller->dma_rx);
@@ -604,9 +604,9 @@ static int fsl_lpspi_dma_transfer(struct spi_controller *controller, 
			return -ETIMEDOUT;

		}



		timeout = wait_for_completion_timeout(&fsl_lpspi->dma_rx_completion,

		time_left = wait_for_completion_timeout(&fsl_lpspi->dma_rx_completion,

							transfer_timeout);

		if (!timeout) {

		if (!time_left) {

			dev_err(fsl_lpspi->dev, "I/O Error in DMA RX\n");

			dmaengine_terminate_all(controller->dma_tx);

			dmaengine_terminate_all(controller->dma_rx);

drivers/spi/spi-imx.c

+10 −10
Original line number Diff line number Diff line
@@ -1405,7 +1405,7 @@ static int spi_imx_dma_transfer(struct spi_imx_data *spi_imx, 
{

	struct dma_async_tx_descriptor *desc_tx, *desc_rx;

	unsigned long transfer_timeout;

	unsigned long timeout;

	unsigned long time_left;

	struct spi_controller *controller = spi_imx->controller;

	struct sg_table *tx = &transfer->tx_sg, *rx = &transfer->rx_sg;

	struct scatterlist *last_sg = sg_last(rx->sgl, rx->nents);
@@ -1471,18 +1471,18 @@ static int spi_imx_dma_transfer(struct spi_imx_data *spi_imx, 
	transfer_timeout = spi_imx_calculate_timeout(spi_imx, transfer->len);



	/* Wait SDMA to finish the data transfer.*/

	timeout = wait_for_completion_timeout(&spi_imx->dma_tx_completion,

	time_left = wait_for_completion_timeout(&spi_imx->dma_tx_completion,

						transfer_timeout);

	if (!timeout) {

	if (!time_left) {

		dev_err(spi_imx->dev, "I/O Error in DMA TX\n");

		dmaengine_terminate_all(controller->dma_tx);

		dmaengine_terminate_all(controller->dma_rx);

		return -ETIMEDOUT;

	}



	timeout = wait_for_completion_timeout(&spi_imx->dma_rx_completion,

	time_left = wait_for_completion_timeout(&spi_imx->dma_rx_completion,

						transfer_timeout);

	if (!timeout) {

	if (!time_left) {

		dev_err(&controller->dev, "I/O Error in DMA RX\n");

		spi_imx->devtype_data->reset(spi_imx);

		dmaengine_terminate_all(controller->dma_rx);
@@ -1501,7 +1501,7 @@ static int spi_imx_pio_transfer(struct spi_device *spi, 
{

	struct spi_imx_data *spi_imx = spi_controller_get_devdata(spi->controller);

	unsigned long transfer_timeout;

	unsigned long timeout;

	unsigned long time_left;



	spi_imx->tx_buf = transfer->tx_buf;

	spi_imx->rx_buf = transfer->rx_buf;
@@ -1517,9 +1517,9 @@ static int spi_imx_pio_transfer(struct spi_device *spi, 


	transfer_timeout = spi_imx_calculate_timeout(spi_imx, transfer->len);



	timeout = wait_for_completion_timeout(&spi_imx->xfer_done,

	time_left = wait_for_completion_timeout(&spi_imx->xfer_done,

						transfer_timeout);

	if (!timeout) {

	if (!time_left) {

		dev_err(&spi->dev, "I/O Error in PIO\n");

		spi_imx->devtype_data->reset(spi_imx);

		return -ETIMEDOUT;

drivers/spi/spi-pic32-sqi.c

+3 −3
Original line number Diff line number Diff line
@@ -344,7 +344,7 @@ static int pic32_sqi_one_message(struct spi_controller *host, 
	struct spi_transfer *xfer;

	struct pic32_sqi *sqi;

	int ret = 0, mode;

	unsigned long timeout;

	unsigned long time_left;

	u32 val;



	sqi = spi_controller_get_devdata(host);
@@ -410,8 +410,8 @@ static int pic32_sqi_one_message(struct spi_controller *host, 
	writel(val, sqi->regs + PESQI_BD_CTRL_REG);



	/* wait for xfer completion */

	timeout = wait_for_completion_timeout(&sqi->xfer_done, 5 * HZ);

	if (timeout == 0) {

	time_left = wait_for_completion_timeout(&sqi->xfer_done, 5 * HZ);

	if (time_left == 0) {

		dev_err(&sqi->host->dev, "wait timedout/interrupted\n");

		ret = -ETIMEDOUT;

		msg->status = ret;

drivers/spi/spi-pic32.c

+3 −3
Original line number Diff line number Diff line
@@ -498,7 +498,7 @@ static int pic32_spi_one_transfer(struct spi_controller *host, 
{

	struct pic32_spi *pic32s;

	bool dma_issued = false;

	unsigned long timeout;

	unsigned long time_left;

	int ret;



	pic32s = spi_controller_get_devdata(host);
@@ -545,8 +545,8 @@ static int pic32_spi_one_transfer(struct spi_controller *host, 
	}



	/* wait for completion */

	timeout = wait_for_completion_timeout(&pic32s->xfer_done, 2 * HZ);

	if (timeout == 0) {

	time_left = wait_for_completion_timeout(&pic32s->xfer_done, 2 * HZ);

	if (time_left == 0) {

		dev_err(&spi->dev, "wait error/timedout\n");

		if (dma_issued) {

			dmaengine_terminate_all(host->dma_rx);