dmaengine.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: dan.j.williams@intel.com, vkoul@kernel.org
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, dmaengine@vger.kernel.org,
	Lee Jones <lee.jones@linaro.org>, Stefan Roese <sr@denx.de>
Subject: [PATCH 07/17] dma: altera-msgdma: Fix struct documentation blocks
Date: Tue, 14 Jul 2020 12:15:36 +0100	[thread overview]
Message-ID: <20200714111546.1755231-8-lee.jones@linaro.org> (raw)
In-Reply-To: <20200714111546.1755231-1-lee.jones@linaro.org>

Fix some misspelling/description issues, demote non-kerneldoc header
to standard comment block and provide a new description for
msgdma_desc_config()'s 'stride' parameter.

Fixes the following W=1 kernel build warning(s):

 drivers/dma/altera-msgdma.c:163: warning: Function parameter or member 'node' not described in 'msgdma_sw_desc'
 drivers/dma/altera-msgdma.c:163: warning: Function parameter or member 'tx_list' not described in 'msgdma_sw_desc'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'lock' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'dev' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'irq_tasklet' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'pending_list' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'free_list' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'active_list' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'done_list' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'desc_free_cnt' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'idle' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'dmadev' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'dmachan' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'hw_desq' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'sw_desq' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'npendings' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'slave_cfg' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'irq' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'csr' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'desc' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:197: warning: Function parameter or member 'resp' not described in 'msgdma_device'
 drivers/dma/altera-msgdma.c:265: warning: Function parameter or member 'stride' not described in 'msgdma_desc_config'

Cc: Stefan Roese <sr@denx.de>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/dma/altera-msgdma.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/drivers/dma/altera-msgdma.c b/drivers/dma/altera-msgdma.c
index 539e785039cac..321ac3a7aa418 100644
--- a/drivers/dma/altera-msgdma.c
+++ b/drivers/dma/altera-msgdma.c
@@ -153,7 +153,8 @@ struct msgdma_extended_desc {
  * struct msgdma_sw_desc - implements a sw descriptor
  * @async_tx: support for the async_tx api
  * @hw_desc: assosiated HW descriptor
- * @free_list: node of the free SW descriprots list
+ * @node: node to move from the free list to the tx list
+ * @tx_list: transmit list node
  */
 struct msgdma_sw_desc {
 	struct dma_async_tx_descriptor async_tx;
@@ -162,7 +163,7 @@ struct msgdma_sw_desc {
 	struct list_head tx_list;
 };
 
-/**
+/*
  * struct msgdma_device - DMA device structure
  */
 struct msgdma_device {
@@ -258,6 +259,7 @@ static void msgdma_free_desc_list(struct msgdma_device *mdev,
  * @dst: Destination buffer address
  * @src: Source buffer address
  * @len: Transfer length
+ * @stride: Read/write stride value to set
  */
 static void msgdma_desc_config(struct msgdma_extended_desc *desc,
 			       dma_addr_t dst, dma_addr_t src, size_t len,
-- 
2.25.1


  parent reply	other threads:[~2020-07-14 11:18 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-14 11:15 [PATCH 00/17] Rid W=1 warnings in DMA Lee Jones
2020-07-14 11:15 ` [PATCH 01/17] dma: mediatek: mtk-hsdma: Fix formatting in 'struct mtk_hsdma_pdesc' doc block Lee Jones
2020-07-14 11:15 ` [PATCH 02/17] dma: of-dma: Fix misspellings/formatting issues in some function headers Lee Jones
2020-07-14 11:15 ` [PATCH 03/17] dma: ep93xx_dma: Provide some missing struct attribute documentation Lee Jones
2020-07-14 11:15 ` [PATCH 04/17] dma: mmp_pdma: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-14 11:15 ` [PATCH 05/17] dma: pl330: Demote obvious misuse of kerneldoc to standard comment block Lee Jones
2020-07-14 11:15 ` [PATCH 06/17] dma: ste_dma40: Supply 2 missing struct attribute descriptions Lee Jones
2020-07-14 11:15 ` Lee Jones [this message]
2020-07-16  7:04   ` [PATCH 07/17] dma: altera-msgdma: Fix struct documentation blocks Stefan Roese
2020-07-14 11:15 ` [PATCH 08/17] dma: at_hdmac: Repair parameter misspelling and demote non-kerneldoc headers Lee Jones
2020-07-14 11:15 ` [PATCH 09/17] dma: sun4i-dma: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-15  2:54   ` Chen-Yu Tsai
2020-07-14 11:15 ` [PATCH 10/17] dma: fsl-qdma: Fix 'struct fsl_qdma_format' formatting issue Lee Jones
2020-07-14 11:15 ` [PATCH 11/17] dma: imx-sdma: Correct formatting issue and provide 2 new descriptions Lee Jones
2020-07-14 11:15 ` [PATCH 12/17] dma: iop-adma: Function parameter documentation must adhere to correct formatting Lee Jones
2020-07-14 11:15 ` [PATCH 13/17] dma: nbpfaxi: Provide some missing attribute docs and split out slave info Lee Jones
2020-07-14 11:15 ` [PATCH 14/17] dma: xgene-dma: Provide descriptions for 'dev' and 'clk' in device's ddata Lee Jones
2020-07-14 11:15 ` [PATCH 15/17] dma: mv_xor_v2: Supply some missing 'struct mv_xor_v2_device' attribute docs Lee Jones
2020-07-14 11:15 ` [PATCH 16/17] dma: ioat: init: Correct misspelling of function parameter 'c' for channel Lee Jones
2020-07-14 11:15 ` [PATCH 17/17] dma: ioat: dma: Fix some parameter misspelling and provide description for phys_complete Lee Jones
2020-07-15 15:29 ` [PATCH 00/17] Rid W=1 warnings in DMA Vinod Koul
2020-07-15 15:37   ` Lee Jones

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=20200714111546.1755231-8-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=dan.j.williams@intel.com \
    --cc=dmaengine@vger.kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sr@denx.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).