From: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
To: Vinod Koul <vkoul@kernel.org>,
dmaengine@vger.kernel.org, Viresh Kumar <vireshk@kernel.org>,
Jarkko Nikula <jarkko.nikula@linux.intel.com>
Cc: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Subject: [PATCH v2 02/10] dmaengine: acpi: Add kernel doc parameter descriptions
Date: Tue, 20 Aug 2019 16:15:38 +0300 [thread overview]
Message-ID: <20190820131546.75744-3-andriy.shevchenko@linux.intel.com> (raw)
In-Reply-To: <20190820131546.75744-1-andriy.shevchenko@linux.intel.com>
Kernel documentation script is not happy about absence of function parameter
descriptions:
drivers/dma/acpi-dma.c:163: warning: Function parameter or member 'data' not described in 'acpi_dma_controller_register'
drivers/dma/acpi-dma.c:247: warning: Function parameter or member 'data' not described in 'devm_acpi_dma_controller_register'
drivers/dma/acpi-dma.c:274: warning: Function parameter or member 'dev' not described in 'devm_acpi_dma_controller_free'
Append the descriptions of above mentioned function parameters.
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
drivers/dma/acpi-dma.c | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/drivers/dma/acpi-dma.c b/drivers/dma/acpi-dma.c
index 4d66ee059808..8a05db3343d3 100644
--- a/drivers/dma/acpi-dma.c
+++ b/drivers/dma/acpi-dma.c
@@ -147,7 +147,7 @@ static void acpi_dma_parse_csrt(struct acpi_device *adev, struct acpi_dma *adma)
* @dev: struct device of DMA controller
* @acpi_dma_xlate: translation function which converts a dma specifier
* 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
*
* Allocated memory should be freed with appropriate acpi_dma_controller_free()
@@ -231,7 +231,7 @@ static void devm_acpi_dma_release(struct device *dev, void *res)
* devm_acpi_dma_controller_register - resource managed acpi_dma_controller_register()
* @dev: device that is registering this DMA controller
* @acpi_dma_xlate: translation function
- * @data pointer to controller specific data
+ * @data: pointer to controller specific data
*
* Managed acpi_dma_controller_register(). DMA controller registered by this
* function are automatically freed on driver detach. See
@@ -264,6 +264,7 @@ EXPORT_SYMBOL_GPL(devm_acpi_dma_controller_register);
/**
* devm_acpi_dma_controller_free - resource managed acpi_dma_controller_free()
+ * @dev: device that is unregistering as DMA controller
*
* Unregister a DMA controller registered with
* devm_acpi_dma_controller_register(). Normally this function will not need to
--
2.23.0.rc1
next prev parent reply other threads:[~2019-08-20 13:15 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-20 13:15 [PATCH v2 00/10] dmaengine: dw: Enable for Intel Elkhart Lake Andy Shevchenko
2019-08-20 13:15 ` [PATCH v2 01/10] dmaengine: acpi: Set up DMA mask based on CSRT Andy Shevchenko
2019-08-20 13:15 ` Andy Shevchenko [this message]
2019-08-20 13:15 ` [PATCH v2 03/10] dmaengine: dw: Export struct dw_dma_chip_pdata for wider use Andy Shevchenko
2019-08-20 13:15 ` [PATCH v2 04/10] dmaengine: dw: platform: Use struct dw_dma_chip_pdata Andy Shevchenko
2019-08-20 13:15 ` [PATCH v2 05/10] dmaengine: dw: platform: Enable iDMA 32-bit on Intel Elkhart Lake Andy Shevchenko
2019-08-20 13:15 ` [PATCH v2 06/10] dmaengine: dw: platform: Use devm_platform_ioremap_resource() Andy Shevchenko
2019-08-20 13:15 ` [PATCH v2 07/10] dmaengine: dw: platform: Switch to acpi_dma_controller_register() Andy Shevchenko
2019-08-20 13:15 ` [PATCH v2 08/10] dmaengine: dw: platform: Move handle check to dw_dma_acpi_controller_register() Andy Shevchenko
2019-08-20 13:15 ` [PATCH v2 09/10] dmaengine: dw: platform: Split ACPI helpers to separate module Andy Shevchenko
2019-08-20 13:15 ` [PATCH v2 10/10] dmaengine: dw: platform: Split OF " Andy Shevchenko
2019-08-21 4:11 ` [PATCH v2 00/10] dmaengine: dw: Enable for Intel Elkhart Lake Vinod Koul
2019-08-28 11:53 ` Andy Shevchenko
2019-08-29 4:32 ` Vinod Koul
2019-08-29 10:39 ` Andy Shevchenko
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=20190820131546.75744-3-andriy.shevchenko@linux.intel.com \
--to=andriy.shevchenko@linux.intel.com \
--cc=dmaengine@vger.kernel.org \
--cc=jarkko.nikula@linux.intel.com \
--cc=vireshk@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
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).