linux-kernel - Re: [PATCH 5/5] dmaengine: owl-dma: fix kernel-doc style for enum

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20201008140403.GB23649@linux>
Date:   Thu, 8 Oct 2020 19:34:03 +0530
From:   Manivannan Sadhasivam <manivannan.sadhasivam@...aro.org>
To:     Vinod Koul <vkoul@...nel.org>
Cc:     dmaengine@...r.kernel.org, Allen Pais <allen.lkml@...il.com>,
        Romain Perier <romain.perier@...il.com>,
        linux-kernel@...r.kernel.org,
        Andreas Färber <afaerber@...e.de>
Subject: Re: [PATCH 5/5] dmaengine: owl-dma: fix kernel-doc style for enum

On Wed, Oct 07, 2020 at 02:01:13PM +0530, Vinod Koul wrote:
> Driver 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
> 

Do we really need to document the max value? Does it produce any warning?

> Signed-off-by: Vinod Koul <vkoul@...nel.org>

Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@...aro.org>

Thanks,
Mani

> ---
>  drivers/dma/owl-dma.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/dma/owl-dma.c b/drivers/dma/owl-dma.c
> index 331c8d8b10a3..9fede32641e9 100644
> --- a/drivers/dma/owl-dma.c
> +++ b/drivers/dma/owl-dma.c
> @@ -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,
> -- 
> 2.26.2
>