dmaengine Archive on lore.kernel.org
 help / color / 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>
Subject: [PATCH 02/17] dma: of-dma: Fix misspellings/formatting issues in some function headers
Date: Tue, 14 Jul 2020 12:15:31 +0100
Message-ID: <20200714111546.1755231-3-lee.jones@linaro.org> (raw)
In-Reply-To: <20200714111546.1755231-1-lee.jones@linaro.org>

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

 drivers/dma/of-dma.c:57: warning: Function parameter or member 'ofdma' not described in 'of_dma_router_xlate'
 drivers/dma/of-dma.c:57: warning: Excess function parameter 'of_dma' description in 'of_dma_router_xlate'
 drivers/dma/of-dma.c:107: warning: Function parameter or member 'data' not described in 'of_dma_controller_register'
 drivers/dma/of-dma.c:308: warning: Function parameter or member 'ofdma' not described in 'of_dma_simple_xlate'
 drivers/dma/of-dma.c:308: warning: Excess function parameter 'of_dma' description in 'of_dma_simple_xlate'
 drivers/dma/of-dma.c:338: warning: Function parameter or member 'ofdma' not described in 'of_dma_xlate_by_chan_id'
 drivers/dma/of-dma.c:338: warning: Excess function parameter 'of_dma' description in 'of_dma_xlate_by_chan_id'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/dma/of-dma.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/dma/of-dma.c b/drivers/dma/of-dma.c
index b2c2b5e8093cf..863f2aaf5c8f7 100644
--- a/drivers/dma/of-dma.c
+++ b/drivers/dma/of-dma.c
@@ -46,7 +46,7 @@ static struct of_dma *of_dma_find_controller(struct of_phandle_args *dma_spec)
 /**
  * of_dma_router_xlate - translation function for router devices
  * @dma_spec:	pointer to DMA specifier as found in the device tree
- * @of_dma:	pointer to DMA controller data (router information)
+ * @ofdma:	pointer to DMA controller data (router information)
  *
  * The function creates new dma_spec to be passed to the router driver's
  * of_dma_route_allocate() function to prepare a dma_spec which will be used
@@ -92,7 +92,7 @@ static struct dma_chan *of_dma_router_xlate(struct of_phandle_args *dma_spec,
  * @np:			device node of DMA controller
  * @of_dma_xlate:	translation function which converts a phandle
  *			arguments list into a dma_chan structure
- * @data		pointer to controller specific data to be used by
+ * @data:		pointer to controller specific data to be used by
  *			translation function
  *
  * Returns 0 on success or appropriate errno value on error.
@@ -295,7 +295,7 @@ EXPORT_SYMBOL_GPL(of_dma_request_slave_channel);
 /**
  * of_dma_simple_xlate - Simple DMA engine translation function
  * @dma_spec:	pointer to DMA specifier as found in the device tree
- * @of_dma:	pointer to DMA controller data
+ * @ofdma:	pointer to DMA controller data
  *
  * A simple translation function for devices that use a 32-bit value for the
  * filter_param when calling the DMA engine dma_request_channel() function.
@@ -323,7 +323,7 @@ EXPORT_SYMBOL_GPL(of_dma_simple_xlate);
 /**
  * of_dma_xlate_by_chan_id - Translate dt property to DMA channel by channel id
  * @dma_spec:	pointer to DMA specifier as found in the device tree
- * @of_dma:	pointer to DMA controller data
+ * @ofdma:	pointer to DMA controller data
  *
  * This function can be used as the of xlate callback for DMA driver which wants
  * to match the channel based on the channel id. When using this xlate function
-- 
2.25.1


  parent reply index

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 ` Lee Jones [this message]
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 ` [PATCH 07/17] dma: altera-msgdma: Fix struct documentation blocks Lee Jones
2020-07-16  7:04   ` 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-3-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=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

dmaengine Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/dmaengine/0 dmaengine/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dmaengine dmaengine/ https://lore.kernel.org/dmaengine \
		dmaengine@vger.kernel.org
	public-inbox-index dmaengine

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.dmaengine


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git