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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <YsUa1qwIb2LzrUjW@matsya>
Date:   Wed, 6 Jul 2022 10:47:10 +0530
From:   Vinod Koul <vkoul@...nel.org>
To:     Shengjiu Wang <shengjiu.wang@....com>
Cc:     shawnguo@...nel.org, s.hauer@...gutronix.de, kernel@...gutronix.de,
        festevam@...il.com, linux-imx@....com, dmaengine@...r.kernel.org,
        linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org
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 <shengjiu.wang@....com>
> ---
>  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