2022-05-18 07:34:54

by Shengjiu Wang

Subject: [PATCH] dmaengine: imx-sdma: Fix compile warning 'Function parameter not described'

Fix compile warning that 'Function parameter or member not described'
with 'W=1' option:

There is no description for struct sdma_script_start_addrs, so use /*
instead of /**

Add missed description for struct sdma_desc

Signed-off-by: Shengjiu Wang <[email protected]>
---
drivers/dma/imx-sdma.c | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/drivers/dma/imx-sdma.c b/drivers/dma/imx-sdma.c
index 95367a8a81a5..111beb7138e0 100644
--- a/drivers/dma/imx-sdma.c
+++ b/drivers/dma/imx-sdma.c
@@ -188,7 +188,7 @@
#define SDMA_DONE0_CONFIG_DONE_SEL BIT(7)
#define SDMA_DONE0_CONFIG_DONE_DIS BIT(6)

-/**
+/*
* struct sdma_script_start_addrs - SDMA script start pointers
*
* start addresses of the different functions in the physical
@@ -424,6 +424,11 @@ struct sdma_desc {
* @data: specific sdma interface structure
* @bd_pool: dma_pool for bd
* @terminate_worker: used to call back into terminate work function
+ * @terminated: terminated list
+ * @is_ram_script: flag for script in ram
+ * @n_fifos_src: number of source device fifos
+ * @n_fifos_dst: number of destination device fifos
+ * @sw_done: software done flag
*/
struct sdma_channel {
struct virt_dma_chan vc;
--
2.17.1

2022-07-06 05:21:44

by Vinod Koul

Subject: Re: [PATCH] dmaengine: imx-sdma: Fix compile warning 'Function parameter not described'

On 18-05-22, 15:21, Shengjiu Wang wrote:
> Fix compile warning that 'Function parameter or member not described'
> with 'W=1' option:
>
> There is no description for struct sdma_script_start_addrs, so use /*
> instead of /**
>
> Add missed description for struct sdma_desc

Patch title should describe the change, so add struct documentation etc
would be apt. Pls revise

>
> Signed-off-by: Shengjiu Wang <[email protected]>
> ---
> drivers/dma/imx-sdma.c | 7 ++++++-
> 1 file changed, 6 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/dma/imx-sdma.c b/drivers/dma/imx-sdma.c
> index 95367a8a81a5..111beb7138e0 100644
> --- a/drivers/dma/imx-sdma.c
> +++ b/drivers/dma/imx-sdma.c
> @@ -188,7 +188,7 @@
> #define SDMA_DONE0_CONFIG_DONE_SEL BIT(7)
> #define SDMA_DONE0_CONFIG_DONE_DIS BIT(6)
>
> -/**
> +/*
> * struct sdma_script_start_addrs - SDMA script start pointers
> *
> * start addresses of the different functions in the physical
> @@ -424,6 +424,11 @@ struct sdma_desc {
> * @data: specific sdma interface structure
> * @bd_pool: dma_pool for bd
> * @terminate_worker: used to call back into terminate work function
> + * @terminated: terminated list
> + * @is_ram_script: flag for script in ram
> + * @n_fifos_src: number of source device fifos
> + * @n_fifos_dst: number of destination device fifos
> + * @sw_done: software done flag
> */
> struct sdma_channel {
> struct virt_dma_chan vc;
> --
> 2.17.1

--
~Vinod

2022-07-06 06:37:17

by Shengjiu Wang

Subject: Re: [PATCH] dmaengine: imx-sdma: Fix compile warning 'Function parameter not described'

>
> On 18-05-22, 15:21, Shengjiu Wang wrote:
> > Fix compile warning that 'Function parameter or member not described'
> > with 'W=1' option:
> >
> > There is no description for struct sdma_script_start_addrs, so use /*
> > instead of /**
> >
> > Add missed description for struct sdma_desc
>
> Patch title should describe the change, so add struct documentation etc
> would be apt. Pls revise
>
Ok, will update it v2.

Best regards
Wang Shengjiu