Fix warning in dmaengine subsystem
Subsystems (5)
Vinod Koul
maintainercover Fix warning in dmaengine subsystem
Some kernel-doc warns have crept in so fix them up.
drivers/dma/altera-msgdma.c:684: warning: Function parameter or member 't' not described in 'msgdma_tasklet' drivers/dma/altera-msgdma.c:684: warning: Excess function parameter 'data' description in 'msgdma_tasklet' drivers/dma/xilinx/zynqmp_dma.c:748: warning: Function parameter or member 't' not described in 'zynqmp_dma_do_tasklet' drivers/dma/xilinx/zynqmp_dma.c:748: warning: Excess function parameter 'data' description in 'zynqmp_dma_do_tasklet' drivers/dma/owl-dma.c:139: warning: cannot understand function prototype: 'enum owl_dmadesc_offsets ' drivers/dma/qcom/bam_dma.c:1078: warning: Function parameter or member 't' not described in 'dma_tasklet' drivers/dma/qcom/bam_dma.c:1078: warning: Excess function parameter 'data' description in 'dma_tasklet' drivers/dma/xilinx/xilinx_dma.c:1050: warning: Function parameter or member 't' not described in 'xilinx_dma_do_tasklet' drivers/dma/xilinx/xilinx_dma.c:1050: warning: Excess function parameter 'data' description in 'xilinx_dma_do_tasklet'
Vinod Koul (5):
dmaengine: altera-msgdma: fix kernel-doc style for tasklet
dmaengine: qcom: bam_dma: fix kernel-doc style for tasklet
dmaengine: xilinx_dma: fix kernel-doc style for tasklet
dmaengine: zynqmp_dma: fix kernel-doc style for tasklet
dmaengine: owl-dma: fix kernel-doc style for enum
drivers/dma/altera-msgdma.c | 2 +- drivers/dma/owl-dma.c | 3 ++- drivers/dma/qcom/bam_dma.c | 2 +- drivers/dma/xilinx/xilinx_dma.c | 2 +- drivers/dma/xilinx/zynqmp_dma.c | 2 +- 5 files changed, 6 insertions(+), 5 deletions(-)
Signature · 1 line
2.26.2
Vinod Koul
maintainerPATCH 1/5 dmaengine: altera-msgdma: fix kernel-doc style for tasklet
Commit 6752e40d669a ("dmaengine: altera-msgdma: convert tasklets to use new tasklet_setup() API") updated driver to use new tasklet_setup() API but missed to update the documentation for the tasklet function.
--- drivers/dma/altera-msgdma.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/dma/altera-msgdma.c +1 -1
@@ -678,7 +678,7 @@ static int msgdma_alloc_chan_resources(struct dma_chan *dchan)/** * msgdma_tasklet - Schedule completion tasklet -* @data: Pointer to the Altera sSGDMA channel structure +* @t: Pointer to the Altera sSGDMA channel structure */ static void msgdma_tasklet (struct tasklet_struct *t) {
Signature · 1 line
2.26.2
Vinod Koul
maintainerPATCH 2/5 dmaengine: qcom: bam_dma: fix kernel-doc style for tasklet
In reply to Vinod KoulCommit 00c4747a2f64 ("dmaengine: qcom: convert tasklets to use new tasklet_setup() API") updated driver to use new tasklet_setup() API but missed to update the documentation for the tasklet function.
--- drivers/dma/qcom/bam_dma.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/dma/qcom/bam_dma.c +1 -1
@@ -1070,7 +1070,7 @@ static void bam_start_dma(struct bam_chan *bchan)/** * dma_tasklet - DMA IRQ tasklet -* @data: tasklet argument (bam controller structure) +* @t: tasklet argument (bam controller structure) * * Sets up next DMA operation and then processes all completed transactions */
Signature · 1 line
2.26.2
Vinod Koul
maintainerPATCH 3/5 dmaengine: xilinx_dma: fix kernel-doc style for tasklet
In reply to Vinod KoulCommit f19a11d40a78 ("dmaengine: xilinx: convert tasklets to use new tasklet_setup() API") updated driver to use new tasklet_setup() API but missed to update the documentation for the tasklet function.
--- drivers/dma/xilinx/xilinx_dma.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/dma/xilinx/xilinx_dma.c +1 -1
@@ -1044,7 +1044,7 @@ static void xilinx_dma_chan_desc_cleanup(struct xilinx_dma_chan *chan)/** * xilinx_dma_do_tasklet - Schedule completion tasklet -* @data: Pointer to the Xilinx DMA channel structure +* @t: Pointer to the Xilinx DMA channel structure */ static void xilinx_dma_do_tasklet (struct tasklet_struct *t) {
Signature · 1 line
2.26.2
Re: [PATCH 3/5] dmaengine: xilinx_dma: fix kernel-doc style for tasklet
Quoted 16 lines · Vinod Koul
Commit
f19a11d40a78("dmaengine: xilinx: convert tasklets to use newtasklet_setup()API") updated driver to use newtasklet_setup()API but missed to update the documentation for the tasklet function.Fixes f19a11d40a78 ("dmaengine: xilinx: convert tasklets to use new tasklet_setup() API")Signed-off-by Vinod Koul <[email protected]>--- drivers/dma/xilinx/xilinx_dma.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/dma/xilinx/xilinx_dma.c +0
-0
drivers/dma/xilinx/xilinx_dma.c static void xilinx_dma_chan_desc_cleanup(struct xilinx_dma_chan *chan) · line 1050
Quoted 8 lines
drivers/dma/xilinx/xilinx_dma.c +1
-1@@ -1044,7 +1044,7 @@ static void xilinx_dma_chan_desc_cleanup(struct xilinx_dma_chan *chan)/** * xilinx_dma_do_tasklet - Schedule completion tasklet -* @data: Pointer to the Xilinx DMA channel structure +* @t: Pointer to the Xilinx DMA channel structure */ static void xilinx_dma_do_tasklet (struct tasklet_struct *t) {
Thanks,
Michal
Vinod Koul
maintainerPATCH 4/5 dmaengine: zynqmp_dma: fix kernel-doc style for tasklet
In reply to Vinod KoulCommit f19a11d40a78 ("dmaengine: xilinx: convert tasklets to use new tasklet_setup() API") updated driver to use new tasklet_setup() API but missed to update the documentation for the tasklet function.
--- drivers/dma/xilinx/zynqmp_dma.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/dma/xilinx/zynqmp_dma.c +1 -1
@@ -742,7 +742,7 @@ static irqreturn_t zynqmp_dma_irq_handler(int irq, void *data)/** * zynqmp_dma_do_tasklet - Schedule completion tasklet -* @data: Pointer to the ZynqMP DMA channel structure +* @t: Pointer to the ZynqMP DMA channel structure */ static void zynqmp_dma_do_tasklet (struct tasklet_struct *t) {
Signature · 1 line
2.26.2
Re: [PATCH 4/5] dmaengine: zynqmp_dma: fix kernel-doc style for tasklet
Quoted 16 lines · Vinod Koul
Commit
f19a11d40a78("dmaengine: xilinx: convert tasklets to use newtasklet_setup()API") updated driver to use newtasklet_setup()API but missed to update the documentation for the tasklet function.Fixes f19a11d40a78 ("dmaengine: xilinx: convert tasklets to use new tasklet_setup() API")Signed-off-by Vinod Koul <[email protected]>--- drivers/dma/xilinx/zynqmp_dma.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/dma/xilinx/zynqmp_dma.c +0
-0
drivers/dma/xilinx/zynqmp_dma.c static irqreturn_t zynqmp_dma_irq_handler(int irq, void *data) · line 748
Quoted 8 lines
drivers/dma/xilinx/zynqmp_dma.c +1
-1@@ -742,7 +742,7 @@ static irqreturn_t zynqmp_dma_irq_handler(int irq, void *data)/** * zynqmp_dma_do_tasklet - Schedule completion tasklet -* @data: Pointer to the ZynqMP DMA channel structure +* @t: Pointer to the ZynqMP DMA channel structure */ static void zynqmp_dma_do_tasklet (struct tasklet_struct *t) {
Thanks,
Michal
Vinod Koul
maintainerPATCH 5/5 dmaengine: owl-dma: fix kernel-doc style for enum
In reply to Vinod KoulDriver doesn't use keyword enum for enum owl_dmadesc_offsets resulting in warning:
drivers/dma/owl-dma.c:139: warning: cannot understand function prototype:
'enum owl_dmadesc_offsets '
So add the keyword to fix it and also add documentation for missing OWL_DMADESC_SIZE
--- drivers/dma/owl-dma.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/dma/owl-dma.c +2 -1
@@ -124,7 +124,7 @@#define FCNT_VAL 0x1/** -* owl_dmadesc_offsets - Describe DMA descriptor, hardware link +* enum owl_dmadesc_offsets - Describe DMA descriptor, hardware link * list for dma transfer * @OWL_DMADESC_NEXT_LLI: physical address of the next link list * @OWL_DMADESC_SADDR: source physical address
@@ -135,6 +135,7 @@* @OWL_DMADESC_CTRLA: dma_mode and linklist ctrl config * @OWL_DMADESC_CTRLB: interrupt config * @OWL_DMADESC_CONST_NUM: data for constant fill +* @OWL_DMADESC_SIZE: max size of this enum */ enum owl_dmadesc_offsets {OWL_DMADESC_NEXT_LLI =0 ,
Signature · 1 line
2.26.2
Re: [PATCH 5/5] dmaengine: owl-dma: fix kernel-doc style for enum
Quoted 9 lines · Vinod Koul
Driver doesn't use keyword enum for enum
owl_dmadesc_offsetsresulting in warning:
drivers/dma/owl-dma.c:139: warning: cannot understand function prototype:
'enumowl_dmadesc_offsets'So add the keyword to fix it and also add documentation for missing
OWL_DMADESC_SIZE
Do we really need to document the max value? Does it produce any warning?
Quoted 1 line
Signed-off-by Vinod Koul <[email protected]>
Thanks,
Mani
Quoted 28 lines
--- drivers/dma/owl-dma.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)drivers/dma/owl-dma.c +2
-1@@ -124,7 +124,7 @@#define FCNT_VAL 0x1/** -* owl_dmadesc_offsets - Describe DMA descriptor, hardware link +* enum owl_dmadesc_offsets - Describe DMA descriptor, hardware link * list for dma transfer * @OWL_DMADESC_NEXT_LLI: physical address of the next link list * @OWL_DMADESC_SADDR: source physical address @@ -135,6 +135,7 @@* @OWL_DMADESC_CTRLA: dma_mode and linklist ctrl config * @OWL_DMADESC_CTRLB: interrupt config * @OWL_DMADESC_CONST_NUM: data for constant fill +* @OWL_DMADESC_SIZE: max size of this enum */ enum owl_dmadesc_offsets {OWL_DMADESC_NEXT_LLI =0 ,Signature · 1 line
2.26.2
Vinod Koul
maintainerRe: [PATCH 5/5] dmaengine: owl-dma: fix kernel-doc style for enum
Quoted 4 lines · Manivannan Sadhasivam
Quoted 3 lines · Vinod Koul
Driver doesn't use keyword enum for enum
owl_dmadesc_offsetsresulting in warning:
Quoted 8 lines
Quoted 6 lines
drivers/dma/owl-dma.c:139: warning: cannot understand function prototype:
'enumowl_dmadesc_offsets'So add the keyword to fix it and also add documentation for missing
OWL_DMADESC_SIZEDo we really need to document the max value? Does it produce any warning?
It does.. Once you add the enum, it will treat is as such and look at members and complain that the OWL_DMADESC_SIZE is not documented ;)
Signature · 1 line
~Vinod