[PATCH] dmaengine: qcom: Fix ADM driver kerneldoc markup

From: Jonathan McDowell
Date: Thu Nov 26 2020 - 13:49:06 EST


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@xxxxxxxx>
---
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