diff options
author | Andy Shevchenko <andriy.shevchenko@linux.intel.com> | 2019-08-20 09:15:38 -0400 |
---|---|---|
committer | Vinod Koul <vkoul@kernel.org> | 2019-08-21 00:11:27 -0400 |
commit | 4b8584bac0407367f8157244c8952ed80bdb12fb (patch) | |
tree | a86b60a04a45cc34d303be507a2a750dfe20248a | |
parent | a6bc332373e5176c2d085657bc643a28950b20b0 (diff) |
dmaengine: acpi: Add kernel doc parameter descriptions
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>
Link: https://lore.kernel.org/r/20190820131546.75744-3-andriy.shevchenko@linux.intel.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>
-rw-r--r-- | drivers/dma/acpi-dma.c | 5 |
1 files 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) | |||
147 | * @dev: struct device of DMA controller | 147 | * @dev: struct device of DMA controller |
148 | * @acpi_dma_xlate: translation function which converts a dma specifier | 148 | * @acpi_dma_xlate: translation function which converts a dma specifier |
149 | * into a dma_chan structure | 149 | * into a dma_chan structure |
150 | * @data pointer to controller specific data to be used by | 150 | * @data: pointer to controller specific data to be used by |
151 | * translation function | 151 | * translation function |
152 | * | 152 | * |
153 | * Allocated memory should be freed with appropriate acpi_dma_controller_free() | 153 | * 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) | |||
231 | * devm_acpi_dma_controller_register - resource managed acpi_dma_controller_register() | 231 | * devm_acpi_dma_controller_register - resource managed acpi_dma_controller_register() |
232 | * @dev: device that is registering this DMA controller | 232 | * @dev: device that is registering this DMA controller |
233 | * @acpi_dma_xlate: translation function | 233 | * @acpi_dma_xlate: translation function |
234 | * @data pointer to controller specific data | 234 | * @data: pointer to controller specific data |
235 | * | 235 | * |
236 | * Managed acpi_dma_controller_register(). DMA controller registered by this | 236 | * Managed acpi_dma_controller_register(). DMA controller registered by this |
237 | * function are automatically freed on driver detach. See | 237 | * function are automatically freed on driver detach. See |
@@ -264,6 +264,7 @@ EXPORT_SYMBOL_GPL(devm_acpi_dma_controller_register); | |||
264 | 264 | ||
265 | /** | 265 | /** |
266 | * devm_acpi_dma_controller_free - resource managed acpi_dma_controller_free() | 266 | * devm_acpi_dma_controller_free - resource managed acpi_dma_controller_free() |
267 | * @dev: device that is unregistering as DMA controller | ||
267 | * | 268 | * |
268 | * Unregister a DMA controller registered with | 269 | * Unregister a DMA controller registered with |
269 | * devm_acpi_dma_controller_register(). Normally this function will not need to | 270 | * devm_acpi_dma_controller_register(). Normally this function will not need to |