From: H Hartley Sweeten <hsweeten@visionengravers.com>
Date: Mon, 2 May 2016 17:11:51 +0000 (-0700)
Subject: staging: comedi: mite: document the remaining exported functions
X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=b21f1fc84cb6ad217e5d450e217767f37ca1dee5;p=linux-beck.git

staging: comedi: mite: document the remaining exported functions

For aesthetics, add docbook comments for the exported functions.

Signed-off-by: H Hartley Sweeten <hsweeten@visionengravers.com>
Reviewed-by: Ian Abbott <abbotti@mev.co.uk>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---

diff --git a/drivers/staging/comedi/drivers/mite.c b/drivers/staging/comedi/drivers/mite.c
index ce479addf1b3..440090e87f2c 100644
--- a/drivers/staging/comedi/drivers/mite.c
+++ b/drivers/staging/comedi/drivers/mite.c
@@ -229,6 +229,10 @@ static u32 mite_device_bytes_transferred(struct mite_channel *mite_chan)
 	return readl(mite->mmio + MITE_DAR(mite_chan->channel));
 }
 
+/**
+ * mite_bytes_in_transit() - Returns the number of unread bytes in the fifo.
+ * @mite_chan: MITE dma channel.
+ */
 u32 mite_bytes_in_transit(struct mite_channel *mite_chan)
 {
 	struct mite *mite = mite_chan->mite;
@@ -349,6 +353,11 @@ static void mite_sync_output_dma(struct mite_channel *mite_chan,
 	}
 }
 
+/**
+ * mite_sync_dma() - Sync the MITE dma with the COMEDI async buffer.
+ * @mite_chan: MITE dma channel.
+ * @s: COMEDI subdevice.
+ */
 void mite_sync_dma(struct mite_channel *mite_chan, struct comedi_subdevice *s)
 {
 	if (mite_chan->dir == COMEDI_INPUT)
@@ -376,6 +385,14 @@ static unsigned int mite_get_status(struct mite_channel *mite_chan)
 	return status;
 }
 
+/**
+ * mite_ack_linkc() - Check and ack the LINKC interrupt,
+ * @mite_chan: MITE dma channel.
+ * @s: COMEDI subdevice.
+ * @sync: flag to force a mite_sync_dma().
+ *
+ * This will also ack the DONE interrupt if active.
+ */
 void mite_ack_linkc(struct mite_channel *mite_chan,
 		    struct comedi_subdevice *s,
 		    bool sync)
@@ -399,6 +416,12 @@ void mite_ack_linkc(struct mite_channel *mite_chan,
 }
 EXPORT_SYMBOL_GPL(mite_ack_linkc);
 
+/**
+ * mite_done() - Check is a MITE dma transfer is complete.
+ * @mite_chan: MITE dma channel.
+ *
+ * This will also ack the DONE interrupt if active.
+ */
 int mite_done(struct mite_channel *mite_chan)
 {
 	struct mite *mite = mite_chan->mite;
diff --git a/drivers/staging/comedi/drivers/mite.h b/drivers/staging/comedi/drivers/mite.h
index c7ae3dbabc23..b6349aed97d0 100644
--- a/drivers/staging/comedi/drivers/mite.h
+++ b/drivers/staging/comedi/drivers/mite.h
@@ -60,11 +60,12 @@ struct mite {
 	spinlock_t lock;
 };
 
-void mite_sync_dma(struct mite_channel *mite_chan, struct comedi_subdevice *s);
-u32 mite_bytes_in_transit(struct mite_channel *mite_chan);
-void mite_ack_linkc(struct mite_channel *, struct comedi_subdevice *,
+u32 mite_bytes_in_transit(struct mite_channel *);
+
+void mite_sync_dma(struct mite_channel *, struct comedi_subdevice *);
+void mite_ack_linkc(struct mite_channel *, struct comedi_subdevice *s,
 		    bool sync);
-int mite_done(struct mite_channel *mite_chan);
+int mite_done(struct mite_channel *);
 
 void mite_dma_arm(struct mite_channel *);
 void mite_dma_disarm(struct mite_channel *);