dmaengine: provide a common function for completing a dma descriptor

Provide a common function to do the cookie mechanics for completing
a DMA descriptor.

Signed-off-by: Russell King <rmk+kernel@arm.linux.org.uk>
Tested-by: Linus Walleij <linus.walleij@linaro.org>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Acked-by: Jassi Brar <jassisinghbrar@gmail.com>
[imx-sdma.c & mxs-dma.c]
Tested-by: Shawn Guo <shawn.guo@linaro.org>
Signed-off-by: Vinod Koul <vinod.koul@linux.intel.com>

19 files changed, 36 insertions, 21 deletions

diff --git a/drivers/dma/amba-pl08x.c b/drivers/dma/amba-pl08x.c
index d8d3dc273f29..346327572cfb 100644
--- a/drivers/dma/amba-pl08x.c
+++ b/drivers/dma/amba-pl08x.c
@@ -1542,7 +1542,7 @@ static void pl08x_tasklet(unsigned long data)
 
         if (txd) {
                 /* Update last completed */
-                plchan->chan.completed_cookie = txd->tx.cookie;
+                dma_cookie_complete(&txd->tx);
         }
 
         /* If a new descriptor is queued, set it up plchan->at is NULL here */
diff --git a/drivers/dma/at_hdmac.c b/drivers/dma/at_hdmac.c
index df47e7d6164b..b2826304da24 100644
--- a/drivers/dma/at_hdmac.c
+++ b/drivers/dma/at_hdmac.c
@@ -249,7 +249,7 @@ atc_chain_complete(struct at_dma_chan *atchan, struct at_desc *desc)
         dev_vdbg(chan2dev(&atchan->chan_common),
                 "descriptor %u complete\n", txd->cookie);
 
-        atchan->chan_common.completed_cookie = txd->cookie;
+        dma_cookie_complete(txd);
 
         /* move children to free_list */
         list_splice_init(&desc->tx_list, &atchan->free_list);
diff --git a/drivers/dma/coh901318.c b/drivers/dma/coh901318.c
index 843a1a3b8a81..24837d700951 100644
--- a/drivers/dma/coh901318.c
+++ b/drivers/dma/coh901318.c
@@ -691,7 +691,7 @@ static void dma_tasklet(unsigned long data)
         callback_param = cohd_fin->desc.callback_param;
 
         /* sign this job as completed on the channel */
-        cohc->chan.completed_cookie = cohd_fin->desc.cookie;
+        dma_cookie_complete(&cohd_fin->desc);
 
         /* release the lli allocation and remove the descriptor */
         coh901318_lli_free(&cohc->base->pool, &cohd_fin->lli);
diff --git a/drivers/dma/dmaengine.h b/drivers/dma/dmaengine.h
index 7692c8644045..47e099772b8e 100644
--- a/drivers/dma/dmaengine.h
+++ b/drivers/dma/dmaengine.h
@@ -5,6 +5,7 @@
 #ifndef DMAENGINE_H
 #define DMAENGINE_H
 
+#include <linux/bug.h>
 #include <linux/dmaengine.h>
 
 /**
@@ -27,4 +28,21 @@ static inline dma_cookie_t dma_cookie_assign(struct dma_async_tx_descriptor *tx)
         return cookie;
 }
 
+/**
+ * dma_cookie_complete - complete a descriptor
+ * @tx: descriptor to complete
+ *
+ * Mark this descriptor complete by updating the channels completed
+ * cookie marker.  Zero the descriptors cookie to prevent accidental
+ * repeated completions.
+ *
+ * Note: caller is expected to hold a lock to prevent concurrency.
+ */
+static inline void dma_cookie_complete(struct dma_async_tx_descriptor *tx)
+{
+        BUG_ON(tx->cookie < DMA_MIN_COOKIE);
+        tx->chan->completed_cookie = tx->cookie;
+        tx->cookie = 0;
+}
+
 #endif
diff --git a/drivers/dma/dw_dmac.c b/drivers/dma/dw_dmac.c
index 3a4ca67ace02..12ea60b2a1be 100644
--- a/drivers/dma/dw_dmac.c
+++ b/drivers/dma/dw_dmac.c
@@ -235,7 +235,7 @@ dwc_descriptor_complete(struct dw_dma_chan *dwc, struct dw_desc *desc,
         dev_vdbg(chan2dev(&dwc->chan), "descriptor %u complete\n", txd->cookie);
 
         spin_lock_irqsave(&dwc->lock, flags);
-        dwc->chan.completed_cookie = txd->cookie;
+        dma_cookie_complete(txd);
         if (callback_required) {
                 callback = txd->callback;
                 param = txd->callback_param;
diff --git a/drivers/dma/ep93xx_dma.c b/drivers/dma/ep93xx_dma.c
index e5aaae87ddfb..1c56f75d9faf 100644
--- a/drivers/dma/ep93xx_dma.c
+++ b/drivers/dma/ep93xx_dma.c
@@ -703,7 +703,7 @@ static void ep93xx_dma_tasklet(unsigned long data)
         desc = ep93xx_dma_get_active(edmac);
         if (desc) {
                 if (desc->complete) {
-                        edmac->chan.completed_cookie = desc->txd.cookie;
+                        dma_cookie_complete(&desc->txd);
                         list_splice_init(&edmac->active, &list);
                 }
                 callback = desc->txd.callback;
diff --git a/drivers/dma/fsldma.c b/drivers/dma/fsldma.c
index 04b4347ba4e9..f36e8b18cba2 100644
--- a/drivers/dma/fsldma.c
+++ b/drivers/dma/fsldma.c
@@ -1081,8 +1081,8 @@ static void dma_do_tasklet(unsigned long data)
 
                 desc = to_fsl_desc(chan->ld_running.prev);
                 cookie = desc->async_tx.cookie;
+                dma_cookie_complete(&desc->async_tx);
 
-                chan->common.completed_cookie = cookie;
                 chan_dbg(chan, "completed_cookie=%d\n", cookie);
         }
 
diff --git a/drivers/dma/imx-dma.c b/drivers/dma/imx-dma.c
index 687fc687aaf6..9a3cbac3d695 100644
--- a/drivers/dma/imx-dma.c
+++ b/drivers/dma/imx-dma.c
@@ -66,7 +66,7 @@ static void imxdma_handle(struct imxdma_channel *imxdmac)
 {
         if (imxdmac->desc.callback)
                 imxdmac->desc.callback(imxdmac->desc.callback_param);
-        imxdmac->chan.completed_cookie = imxdmac->desc.cookie;
+        dma_cookie_complete(&imxdmac->desc);
 }
 
 static void imxdma_irq_handler(int channel, void *data)
diff --git a/drivers/dma/imx-sdma.c b/drivers/dma/imx-sdma.c
index 3f0c002933f3..981071ebd5c8 100644
--- a/drivers/dma/imx-sdma.c
+++ b/drivers/dma/imx-sdma.c
@@ -530,7 +530,7 @@ static void mxc_sdma_handle_channel_normal(struct sdma_channel *sdmac)
         else
                 sdmac->status = DMA_SUCCESS;
 
-        sdmac->chan.completed_cookie = sdmac->desc.cookie;
+        dma_cookie_complete(&sdmac->desc);
         if (sdmac->desc.callback)
                 sdmac->desc.callback(sdmac->desc.callback_param);
 }
diff --git a/drivers/dma/intel_mid_dma.c b/drivers/dma/intel_mid_dma.c
index e9217c390b76..cee79f6e035d 100644
--- a/drivers/dma/intel_mid_dma.c
+++ b/drivers/dma/intel_mid_dma.c
@@ -290,7 +290,7 @@ static void midc_descriptor_complete(struct intel_mid_dma_chan *midc,
         struct intel_mid_dma_lli        *llitem;
         void *param_txd = NULL;
 
-        midc->chan.completed_cookie = txd->cookie;
+        dma_cookie_complete(txd);
         callback_txd = txd->callback;
         param_txd = txd->callback_param;
 
diff --git a/drivers/dma/ioat/dma.c b/drivers/dma/ioat/dma.c
index 5c06117ac682..b0517c86c1bb 100644
--- a/drivers/dma/ioat/dma.c
+++ b/drivers/dma/ioat/dma.c
@@ -600,8 +600,7 @@ static void __cleanup(struct ioat_dma_chan *ioat, unsigned long phys_complete)
                  */
                 dump_desc_dbg(ioat, desc);
                 if (tx->cookie) {
-                        chan->common.completed_cookie = tx->cookie;
-                        tx->cookie = 0;
+                        dma_cookie_complete(tx);
                         ioat_dma_unmap(chan, tx->flags, desc->len, desc->hw);
                         ioat->active -= desc->hw->tx_cnt;
                         if (tx->callback) {
diff --git a/drivers/dma/ioat/dma_v2.c b/drivers/dma/ioat/dma_v2.c
index 17ecacb70d40..e8e110ff3d96 100644
--- a/drivers/dma/ioat/dma_v2.c
+++ b/drivers/dma/ioat/dma_v2.c
@@ -149,8 +149,7 @@ static void __cleanup(struct ioat2_dma_chan *ioat, unsigned long phys_complete)
                 dump_desc_dbg(ioat, desc);
                 if (tx->cookie) {
                         ioat_dma_unmap(chan, tx->flags, desc->len, desc->hw);
-                        chan->common.completed_cookie = tx->cookie;
-                        tx->cookie = 0;
+                        dma_cookie_complete(tx);
                         if (tx->callback) {
                                 tx->callback(tx->callback_param);
                                 tx->callback = NULL;
diff --git a/drivers/dma/ioat/dma_v3.c b/drivers/dma/ioat/dma_v3.c
index d4afac741e8a..1bda46c43bd7 100644
--- a/drivers/dma/ioat/dma_v3.c
+++ b/drivers/dma/ioat/dma_v3.c
@@ -277,9 +277,8 @@ static void __cleanup(struct ioat2_dma_chan *ioat, unsigned long phys_complete)
                 dump_desc_dbg(ioat, desc);
                 tx = &desc->txd;
                 if (tx->cookie) {
-                        chan->common.completed_cookie = tx->cookie;
+                        dma_cookie_complete(tx);
                         ioat3_dma_unmap(ioat, desc, idx + i);
-                        tx->cookie = 0;
                         if (tx->callback) {
                                 tx->callback(tx->callback_param);
                                 tx->callback = NULL;
diff --git a/drivers/dma/ipu/ipu_idmac.c b/drivers/dma/ipu/ipu_idmac.c
index d4620c53fd2d..bff9250a59ce 100644
--- a/drivers/dma/ipu/ipu_idmac.c
+++ b/drivers/dma/ipu/ipu_idmac.c
@@ -1289,7 +1289,7 @@ static irqreturn_t idmac_interrupt(int irq, void *dev_id)
         /* Flip the active buffer - even if update above failed */
         ichan->active_buffer = !ichan->active_buffer;
         if (done)
-                ichan->dma_chan.completed_cookie = desc->txd.cookie;
+                dma_cookie_complete(&desc->txd);
 
         callback = desc->txd.callback;
         callback_param = desc->txd.callback_param;
diff --git a/drivers/dma/mxs-dma.c b/drivers/dma/mxs-dma.c
index 4d3b6ff3050f..5f3492e5d28f 100644
--- a/drivers/dma/mxs-dma.c
+++ b/drivers/dma/mxs-dma.c
@@ -262,7 +262,7 @@ static irqreturn_t mxs_dma_int_handler(int irq, void *dev_id)
                 stat1 &= ~(1 << channel);
 
                 if (mxs_chan->status == DMA_SUCCESS)
-                        mxs_chan->chan.completed_cookie = mxs_chan->desc.cookie;
+                        dma_cookie_complete(&mxs_chan->desc);
 
                 /* schedule tasklet on this channel */
                 tasklet_schedule(&mxs_chan->tasklet);
diff --git a/drivers/dma/pl330.c b/drivers/dma/pl330.c
index 644eb789958b..a81d0a5f8191 100644
--- a/drivers/dma/pl330.c
+++ b/drivers/dma/pl330.c
@@ -233,7 +233,7 @@ static void pl330_tasklet(unsigned long data)
         /* Pick up ripe tomatoes */
         list_for_each_entry_safe(desc, _dt, &pch->work_list, node)
                 if (desc->status == DONE) {
-                        pch->chan.completed_cookie = desc->txd.cookie;
+                        dma_cookie_complete(&desc->txd);
                         list_move_tail(&desc->node, &list);
                 }
 
diff --git a/drivers/dma/ste_dma40.c b/drivers/dma/ste_dma40.c
index 23e2edc4afd4..c2463758fed1 100644
--- a/drivers/dma/ste_dma40.c
+++ b/drivers/dma/ste_dma40.c
@@ -1347,7 +1347,7 @@ static void dma_tasklet(unsigned long data)
                 goto err;
 
         if (!d40d->cyclic)
-                d40c->chan.completed_cookie = d40d->txd.cookie;
+                dma_cookie_complete(&d40d->txd);
 
         /*
          * If terminating a channel pending_tx is set to zero.
diff --git a/drivers/dma/timb_dma.c b/drivers/dma/timb_dma.c
index b6e83fc27c4e..1845ac9d6e88 100644
--- a/drivers/dma/timb_dma.c
+++ b/drivers/dma/timb_dma.c
@@ -285,7 +285,7 @@ static void __td_finish(struct timb_dma_chan *td_chan)
         else
                 iowrite32(0, td_chan->membase + TIMBDMA_OFFS_TX_DLAR);
 */
-        td_chan->chan.completed_cookie = txd->cookie;
+        dma_cookie_complete(txd);
         td_chan->ongoing = false;
 
         callback = txd->callback;
diff --git a/drivers/dma/txx9dmac.c b/drivers/dma/txx9dmac.c
index 66f8fca1bd3c..8a5225bf9bc9 100644
--- a/drivers/dma/txx9dmac.c
+++ b/drivers/dma/txx9dmac.c
@@ -411,7 +411,7 @@ txx9dmac_descriptor_complete(struct txx9dmac_chan *dc,
         dev_vdbg(chan2dev(&dc->chan), "descriptor %u %p complete\n",
                  txd->cookie, desc);
 
-        dc->chan.completed_cookie = txd->cookie;
+        dma_cookie_complete(txd);
         callback = txd->callback;
         param = txd->callback_param;