All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	"David S. Miller" <davem@davemloft.net>,
	linux-ide@vger.kernel.org
Subject: [PATCH 03/21] ide: ide-dma-sff: Provide some missing 'param' descriptions
Date: Wed,  2 Jun 2021 11:17:04 +0100	[thread overview]
Message-ID: <20210602101722.2276638-4-lee.jones@linaro.org> (raw)
In-Reply-To: <20210602101722.2276638-1-lee.jones@linaro.org>

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

 drivers/ide/ide-dma-sff.c:84: warning: Function parameter or member 'on' not described in 'ide_dma_host_set'
 drivers/ide/ide-dma-sff.c:116: warning: Function parameter or member 'drive' not described in 'ide_build_dmatable'
 drivers/ide/ide-dma-sff.c:116: warning: Function parameter or member 'cmd' not described in 'ide_build_dmatable'

Cc: "David S. Miller" <davem@davemloft.net>
Cc: linux-ide@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/ide/ide-dma-sff.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/ide/ide-dma-sff.c b/drivers/ide/ide-dma-sff.c
index b7c2c0bd18b53..8603df4d92fd8 100644
--- a/drivers/ide/ide-dma-sff.c
+++ b/drivers/ide/ide-dma-sff.c
@@ -75,6 +75,7 @@ static void ide_dma_sff_write_status(ide_hwif_t *hwif, u8 val)
 /**
  *	ide_dma_host_set	-	Enable/disable DMA on a host
  *	@drive: drive to control
+ *	@on: whether to enable/disable the IDE controller's DMA
  *
  *	Enable/disable DMA on an IDE controller following generic
  *	bus-mastering IDE controller behaviour.
@@ -98,6 +99,9 @@ EXPORT_SYMBOL_GPL(ide_dma_host_set);
 /**
  *	ide_build_dmatable	-	build IDE DMA table
  *
+ *	@drive: The drive to unmap
+ *	@cmd: The IDEcommand
+ *
  *	ide_build_dmatable() prepares a dma request. We map the command
  *	to get the pci bus addresses of the buffers and then build up
  *	the PRD table that the IDE layer wants to be fed.
-- 
2.31.1


  parent reply	other threads:[~2021-06-02 10:17 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-02 10:17 [PATCH 00/21] Rid W=1 warnings from IDE Lee Jones
2021-06-02 10:17 ` Lee Jones
2021-06-02 10:17 ` [PATCH 01/21] ide: alim15x3: Document alim15x3_init_one()'s 'id' param Lee Jones
2021-06-02 10:17 ` [PATCH 02/21] ide: ide-dma: Document ide_dma_unmap_sg()'s missing 'cmd' param Lee Jones
2021-06-02 10:17 ` Lee Jones [this message]
2021-06-02 10:17 ` [PATCH 04/21] ide: ide-io: Fix a few kernel-doc misdemeanours Lee Jones
2021-06-02 10:17 ` [PATCH 05/21] ide: ide-proc: Strip out unused fops structure and accompanying call-back Lee Jones
2021-06-02 10:17 ` [PATCH 06/21] ide: cs5530: Fix incorrect documentation for function init_chipset_cs5530() Lee Jones
2021-06-02 10:17 ` [PATCH 07/21] ide: ide-probe: Fix-up incorrectly documented function probe_for_drive() Lee Jones
2021-06-02 10:17 ` [PATCH 08/21] ide: hpt366: Provide some missing descriptions for 'f_{low,high}' Lee Jones
2021-06-02 10:17 ` [PATCH 09/21] ide: piix: Remove unused variable 'sitre' Lee Jones
2021-06-02 10:17 ` [PATCH 10/21] ide: pdc202xx_new: Supply missing description for 'set_indexed_reg()'s 'value' param Lee Jones
2021-06-02 10:17 ` [PATCH 11/21] ide: slc90e66: Remove unused variable 'sitre' Lee Jones
2021-06-02 10:17 ` [PATCH 12/21] ide: it821x: Fix a couple of incorrectly documented functions Lee Jones
2021-06-02 10:17 ` [PATCH 13/21] ide: siimage: Fix some incorrectly documented functions/params Lee Jones
2021-06-02 10:17 ` [PATCH 14/21] ide: via82cxxx: Fix misdocumentation of via_set_speed()'s 'hwif' param Lee Jones
2021-06-02 10:17 ` [PATCH 15/21] ide: ide-cd_ioctl: Remove unused variable 'stat' Lee Jones
2021-06-02 10:17 ` [PATCH 16/21] ide: ide-cd: Demote kernel-doc abuse Lee Jones
2021-06-02 10:17 ` [PATCH 17/21] ide: ide-acpi: Mark debugging variable 'bus' as __maybe_unused Lee Jones
2021-06-02 10:17 ` [PATCH 18/21] ide: ide-io: Document ide_intr()'s param 'irq' Lee Jones
2021-06-02 10:17 ` [PATCH 19/21] ide: piix: Fix incorrectly documented param 'hwif' Lee Jones
2021-06-02 10:17 ` [PATCH 20/21] ide: ide-acpi: Provide missing description for param 'obj_loc' Lee Jones
2021-06-02 10:17 ` [PATCH 21/21] ide: pmac: Staticise local function 'pmac_ide_probe' Lee Jones
2021-06-02 10:17   ` Lee Jones
2021-06-07  8:26 ` [PATCH 00/21] Rid W=1 warnings from IDE Christoph Hellwig
2021-06-07  8:26   ` Christoph Hellwig
2021-06-14  9:12   ` Lee Jones
2021-06-14  9:12     ` Lee Jones
2021-06-16 13:52     ` Christoph Hellwig
2021-06-16 13:52       ` Christoph Hellwig

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=20210602101722.2276638-4-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=davem@davemloft.net \
    --cc=linux-ide@vger.kernel.org \
    --cc=linux-kernel@vger.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.