dmaengine: qcom: Fix ADM driver kerneldoc markup
Subsystems (2)
PATCH 1/1 dmaengine: qcom: Fix ADM driver kerneldoc markup
Update the kerneldoc function headers to fix build warnings:
drivers/dma/qcom/qcom_adm.c:180: warning: Function parameter or member 'chan' not described in 'adm_free_chan' drivers/dma/qcom/qcom_adm.c:190: warning: Function parameter or member 'burst' not described in 'adm_get_blksize' drivers/dma/qcom/qcom_adm.c:466: warning: Function parameter or member 'chan' not described in 'adm_terminate_all' drivers/dma/qcom/qcom_adm.c:466: warning: Excess function parameter 'achan' description in 'adm_terminate_all' drivers/dma/qcom/qcom_adm.c:503: warning: Function parameter or member 'achan' not described in 'adm_start_dma'
--- drivers/dma/qcom/qcom_adm.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
drivers/dma/qcom/qcom_adm.c +5 -3
@@ -173,8 +173,9 @@ struct adm_device {/** * adm_free_chan - Frees dma resources associated with the specific channel * -* Free all allocated descriptors associated with this channel +* @chan: dma channel * +* Free all allocated descriptors associated with this channel */ static void adm_free_chan (struct dma_chan *chan) {
@@ -185,6 +186,7 @@ static void adm_free_chan(struct dma_chan *chan)/** * adm_get_blksize - Get block size from burst value * +* @burst: Burst size of transaction */ static int adm_get_blksize (unsigned int burst) {
@@ -456,7 +458,7 @@ static struct dma_async_tx_descriptor *adm_prep_slave_sg(struct dma_chan *chan,/** * adm_terminate_all - terminate all transactions on a channel -* @achan: adm dma channel +* @chan: dma channel * * Dequeues and frees all transactions, aborts current transaction * No callbacks are done
@@ -497,7 +499,7 @@ static int adm_slave_config(struct dma_chan *chan, struct dma_slave_config *cfg)/** * adm_start_dma - start next transaction -* @achan - ADM dma channel +* @achan: ADM dma channel */ static void adm_start_dma (struct adm_chan *achan) {
Signature · 1 line
2.20.1
Quoted 7 lines · Jonathan McDowell
Update the kerneldoc function headers to fix build warnings:
drivers/dma/qcom/qcom_adm.c:180: warning: Function parameter or member 'chan' not described in 'adm_free_chan'drivers/dma/qcom/qcom_adm.c:190: warning: Function parameter or member 'burst' not described in 'adm_get_blksize'drivers/dma/qcom/qcom_adm.c:466: warning: Function parameter or member 'chan' not described in 'adm_terminate_all'drivers/dma/qcom/qcom_adm.c:466: warning: Excess function parameter 'achan' description in 'adm_terminate_all'drivers/dma/qcom/qcom_adm.c:503: warning: Function parameter or member 'achan' not described in 'adm_start_dma'
Applied, thanks
Signature · 1 line
~Vinod
This patch was applied to qcom/linux.git (refs/heads/for-next):
Hello:
This patch was applied to qcom/linux.git (refs/heads/for-next):
Quoted 9 lines · On Thu, 26 Nov 2020 18:46:02 +0000 you wrote:
Update the kerneldoc function headers to fix build warnings:
drivers/dma/qcom/qcom_adm.c:180: warning: Function parameter or member 'chan' not described in 'adm_free_chan'drivers/dma/qcom/qcom_adm.c:190: warning: Function parameter or member 'burst' not described in 'adm_get_blksize'drivers/dma/qcom/qcom_adm.c:466: warning: Function parameter or member 'chan' not described in 'adm_terminate_all'drivers/dma/qcom/qcom_adm.c:466: warning: Excess function parameter 'achan' description in 'adm_terminate_all'drivers/dma/qcom/qcom_adm.c:503: warning: Function parameter or member 'achan' not described in 'adm_start_dma'[...]
Here is the summary with links:
- dmaengine: qcom: Fix ADM driver kerneldoc markup
https://git.kernel.org/qcom/c/4facce4c1263
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html