From: Jonathan McDowell <noodles@earth.li>
To: Vinod Koul <vkoul@kernel.org>, Andy Gross <agross@kernel.org>,
Bjorn Andersson <bjorn.andersson@linaro.org>,
Dan Williams <dan.j.williams@intel.com>,
Philipp Zabel <p.zabel@pengutronix.de>,
linux-kernel@vger.kernel.org, linux-arm-msm@vger.kernel.org,
dmaengine@vger.kernel.org
Subject: [PATCH] dmaengine: qcom: Fix ADM driver kerneldoc markup
Date: Thu, 26 Nov 2020 18:46:02 +0000 [thread overview]
Message-ID: <20201126184602.GA1008@earth.li> (raw)
Update the kerneldoc function headers to fix build warnings:
drivers/dma/qcom/qcom_adm.c:180: warning: Function parameter or member 'chan' not described in 'adm_free_chan'
drivers/dma/qcom/qcom_adm.c:190: warning: Function parameter or member 'burst' not described in 'adm_get_blksize'
drivers/dma/qcom/qcom_adm.c:466: warning: Function parameter or member 'chan' not described in 'adm_terminate_all'
drivers/dma/qcom/qcom_adm.c:466: warning: Excess function parameter 'achan' description in 'adm_terminate_all'
drivers/dma/qcom/qcom_adm.c:503: warning: Function parameter or member 'achan' not described in 'adm_start_dma'
Signed-off-by: Jonathan McDowell <noodles@earth.li>
---
drivers/dma/qcom/qcom_adm.c | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/drivers/dma/qcom/qcom_adm.c b/drivers/dma/qcom/qcom_adm.c
index 9b6f8e050ecc..ee78bed8d60d 100644
--- a/drivers/dma/qcom/qcom_adm.c
+++ b/drivers/dma/qcom/qcom_adm.c
@@ -173,8 +173,9 @@ struct adm_device {
/**
* adm_free_chan - Frees dma resources associated with the specific channel
*
- * Free all allocated descriptors associated with this channel
+ * @chan: dma channel
*
+ * Free all allocated descriptors associated with this channel
*/
static void adm_free_chan(struct dma_chan *chan)
{
@@ -185,6 +186,7 @@ static void adm_free_chan(struct dma_chan *chan)
/**
* adm_get_blksize - Get block size from burst value
*
+ * @burst: Burst size of transaction
*/
static int adm_get_blksize(unsigned int burst)
{
@@ -456,7 +458,7 @@ static struct dma_async_tx_descriptor *adm_prep_slave_sg(struct dma_chan *chan,
/**
* adm_terminate_all - terminate all transactions on a channel
- * @achan: adm dma channel
+ * @chan: dma channel
*
* Dequeues and frees all transactions, aborts current transaction
* No callbacks are done
@@ -497,7 +499,7 @@ static int adm_slave_config(struct dma_chan *chan, struct dma_slave_config *cfg)
/**
* adm_start_dma - start next transaction
- * @achan - ADM dma channel
+ * @achan: ADM dma channel
*/
static void adm_start_dma(struct adm_chan *achan)
{
--
2.20.1
next reply other threads:[~2020-11-26 18:46 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-26 18:46 Jonathan McDowell [this message]
2020-12-11 13:36 ` [PATCH] dmaengine: qcom: Fix ADM driver kerneldoc markup Vinod Koul
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201126184602.GA1008@earth.li \
--to=noodles@earth.li \
--cc=agross@kernel.org \
--cc=bjorn.andersson@linaro.org \
--cc=dan.j.williams@intel.com \
--cc=dmaengine@vger.kernel.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=p.zabel@pengutronix.de \
--cc=vkoul@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).